diff options
| author | Steadman <mark@steadman.io> | 2015-06-04 11:35:47 +0100 |
|---|---|---|
| committer | Erik Romijn <eromijn@solidlinks.nl> | 2015-06-04 11:58:32 +0100 |
| commit | dfdcb3ca226023c4166c69abccc7f627ea69aa80 (patch) | |
| tree | ea9669bd931955bdc92de482ed946004ddb32216 /docs/internals/contributing/writing-documentation.txt | |
| parent | 40f2325df68b81e53ab6ab16a0001ee7c2026fc4 (diff) | |
Improved wording in writing documentation docs.
Diffstat (limited to 'docs/internals/contributing/writing-documentation.txt')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index a31b1008d8..58d7632864 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -210,7 +210,7 @@ Our policy for new features is: Our preferred way for marking new features is by prefacing the features' 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 should use the "``.. versionchanged:: X.Y``" directive (with the same format |