IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix-up half-sentence.

Browse Source
This commit is contained in:
Georg Brandl 2011-01-03 23:50:30 +01:00
parent f6cb763ff8
commit a304c8d247
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/ext/autodoc.rst
View File

@ -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