diff options
| author | Georg Brandl <georg@python.org> | 2011-01-03 23:50:30 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-01-03 23:50:30 +0100 |
| commit | 85e9bfac52582539293bf1dbc582340f7a40d5cc (patch) | |
| tree | 2b9bb62e4a06e8ef0549149e20598b3143723028 /doc | |
| parent | 456faf0608a738c9c3163c887d517633deb6a413 (diff) | |
| download | sphinx-85e9bfac52582539293bf1dbc582340f7a40d5cc.tar.gz | |
Fix-up half-sentence.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ext/autodoc.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 483b30fa..6c4a147a 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -289,7 +289,8 @@ There are also new config values that you can set: Functions imported from C modules cannot be introspected, and therefore the signature for such functions cannot be automatically determined. However, it - is a well- convention + is an often-used convention to put the signature into the first line of the + function's docstring. If this boolean value is set to ``True`` (which is the default), autodoc will look at the first line of the docstring for functions and methods, and if it |