diff options
| author | Juan Catalano <jc@streema.com> | 2013-03-24 22:48:23 -0700 |
|---|---|---|
| committer | Claude Paroz <claude@2xlibre.net> | 2013-04-20 17:18:21 +0200 |
| commit | 4e25198ec298732409217321be10e1e06be2fcbd (patch) | |
| tree | 52280af9e8165e6c92f5d291343bc879bb5d8614 /docs/internals/contributing/writing-documentation.txt | |
| parent | 3be8165b6267bea021df6e6c4e758a4c877c961e (diff) | |
Fixed #20104 -- Changed VersionDirective in order to avoid ambiguity.
As explained in ticket #20104, the use of versionchanged/versionadded
was confusing.
To solve this ambiguity these directives no longer accept a second
argument but now they only receive the version number (1st arg) and then
a content with the proper comment.
Diffstat (limited to 'docs/internals/contributing/writing-documentation.txt')
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 469f8614b9..2944dea504 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -188,8 +188,8 @@ Our policy for new features is: release, not the development version. Our preferred way for marking new features is by prefacing the features' -documentation with: "``.. versionadded:: X.Y``", followed by an optional one -line comment and a mandatory blank line. +documentation with: "``.. versionadded:: X.Y``", followed by a a mandatory +blank line and an optional content (indented). General improvements, or other changes to the APIs that should be emphasized should use the "``.. versionchanged:: X.Y``" directive (with the same format |