diff options
| author | Waylan Limberg <waylan@gmail.com> | 2014-08-29 22:18:10 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan@gmail.com> | 2014-08-29 22:18:10 -0400 |
| commit | 5f941454f9f7c8b62efec24917b2c7ba983d603c (patch) | |
| tree | f91ca2be452c6964d608b1e4d46b60d339e928ec /docs/reference.txt | |
| parent | 3fda9d59fe0bd3a09c888ebadf92afffb2a74690 (diff) | |
| download | markdown-5f941454f9f7c8b62efec24917b2c7ba983d603c.tar.gz markdown-5f941454f9f7c8b62efec24917b2c7ba983d603c.tar.bz2 markdown-5f941454f9f7c8b62efec24917b2c7ba983d603c.zip | |
Some docs cleanup.
Diffstat (limited to 'docs/reference.txt')
| -rw-r--r-- | docs/reference.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/reference.txt b/docs/reference.txt index afc3b05..e1797ad 100644 --- a/docs/reference.txt +++ b/docs/reference.txt @@ -68,7 +68,7 @@ The following options are available on the `markdown.markdown` function: extensions=[MyExtension(), 'path.to.my.ext'] - !!! warning + !!! note The prefered method is to pass in an instance of an extension. Strings should only be used when it is impossable to import the Extension Class directly (from the command line or in a template). @@ -101,9 +101,10 @@ The following options are available on the `markdown.markdown` function: "path.to.module:SomeExtensionClass" !!! note - You should only need to specify the class name if more than one extension is defined - within the same module. The extensions that come with Python-Markdown do *not* - need to have the class name specified. + You should only need to specify the class name if more than one extension + is defined within the same module. The extensions that come with + Python-Markdown do *not* need to have the class name specified. However, + doing so will not effect the behavior of the parser. When loading an extension by name (as a string), you may pass in configuration settings to the extension using the @@ -122,7 +123,7 @@ The following options are available on the `markdown.markdown` function: !!! Note The prefered method is to pass in an instance of an extension, which - does not require use of the `extension_configs` keyword at all. + does not require use of the `extension_configs` keyword at all. See the [extensions](#extensions) keyword for details. The dictionary of configuration settings must be in the following format: |