Changeset 4541

Show
Ignore:
Timestamp:
10/20/08 04:47:53 (3 months ago)
Author:
cboos
Message:

GraphvizPlugin: more documentation fixes.

Also, the name of the cache_min_count option was mistyped, fixed.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • graphvizplugin/0.11/graphviz/graphviz.py

    r4540 r4541  
    7878    cache_dir_option = Option("graphviz", "cache_dir", DEFAULT_CACHE_DIR, 
    7979            """The directory that will be used to cache the generated images. 
    80             Note that if different than the default (%s), this directory must 
     80            Note that if different than the default (`%s`), this directory must 
    8181            exist. 
    8282            If not given as an absolute path, the path will be relative to  
    …… 
    8686    encoding = Option("graphviz", "encoding", 'utf-8', 
    8787            """The encoding which should be used for communicating with 
    88             Graphviz (should match -Gcharset if given). 
     88            Graphviz (should match `-Gcharset` if given). 
    8989            """) 
    9090 
    …… 
    9292            r"""Full path to the directory where the graphviz 
    9393            programs are located. If not specified, the 
    94             default is /usr/bin on Linux, c:\Program 
    95             Files\ATT\Graphviz\bin on Windows and 
    96             /usr/local/bin on FreeBSD 6. 
     94            default is `/usr/bin` on Linux,  
     95            `C:\Program Files\ATT\Graphviz\bin` on Windows and 
     96            `/usr/local/bin` on FreeBSD 6. 
    9797            """) 
    9898 
    …… 
    110110            be overrided on a per-graph basis. 
    111111 
    112             GraphvizMacro will verify that the default 
     112            !GraphvizMacro will verify that the default 
    113113            processor is installed and will not work if it 
    114114            is missing. All other processors are optional. 
    115115            If any of the other processors are missing, a 
    116116            warning message will be sent to the trac log and 
    117             GraphvizMacro will continue to work. 
     117            !GraphvizMacro will continue to work. 
    118118            """) 
    119119 
    …… 
    155155            """) 
    156156 
    157     cache_min_count = IntOption("graphviz", "cache_minax_count", 1500, 
    158             """The maximum number of files that the cache should 
    159             contain. This is the high watermark for the 
     157    cache_min_count = IntOption("graphviz", "cache_min_count", 1500, 
     158            """The minimum number of files that the cache should 
     159            contain. This is the low watermark for the 
    160160            directory entry count. 
    161161            """)