mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix-up half-sentence.
This commit is contained in:
parent
f6cb763ff8
commit
a304c8d247
@ -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
|
Functions imported from C modules cannot be introspected, and therefore the
|
||||||
signature for such functions cannot be automatically determined. However, it
|
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
|
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
|
look at the first line of the docstring for functions and methods, and if it
|
||||||
|
Loading…
Reference in New Issue
Block a user