Improved wording in writing documentation docs.
This commit is contained in:
parent
40f2325df6
commit
dfdcb3ca22
|
@ -210,7 +210,7 @@ Our policy for new features is:
|
||||||
|
|
||||||
Our preferred way for marking new features is by prefacing the features'
|
Our preferred way for marking new features is by prefacing the features'
|
||||||
documentation with: "``.. versionadded:: X.Y``", followed by a mandatory
|
documentation with: "``.. versionadded:: X.Y``", followed by a mandatory
|
||||||
blank line and an optional content (indented).
|
blank line and an optional description (indented).
|
||||||
|
|
||||||
General improvements, or other changes to the APIs that should be emphasized
|
General improvements, or other changes to the APIs that should be emphasized
|
||||||
should use the "``.. versionchanged:: X.Y``" directive (with the same format
|
should use the "``.. versionchanged:: X.Y``" directive (with the same format
|
||||||
|
|
Loading…
Reference in New Issue