[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

Georg Brandl report at bugs.python.org
Fri Feb 19 03:01:18 EST 2016


Georg Brandl added the comment:

Here are the original descriptions of the old LaTeX version.

    \begin{macrodesc}{versionadded}{\op{explanation}\p{version}}
      The version of Python which added the described feature to the
      library or C API.  \var{explanation} should be a \emph{brief}
      explanation of the change consisting of a capitalized sentence
      fragment; a period will be appended by the formatting process.
      When this applies to an entire module, it should be placed at
      the top of the module section before any prose.
    \end{macrodesc}

    \begin{macrodesc}{versionchanged}{\op{explanation}\p{version}}
      The version of Python in which the named feature was changed in
      some way (new parameters, changed side effects, etc.).
      \var{explanation} should be a \emph{brief} explanation of the
      change consisting of a capitalized sentence fragment; a
      period will be appended by the formatting process.  This should
      not generally be applied to modules.
    \end{macrodesc}

Adding a parameter is explicitly a "versionchanged" kind of change.

Since the Sphinx items are supposed to be equivalent, this has always been the intention, even if the current devguide deviates.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue26366>
_______________________________________


More information about the Python-bugs-list mailing list