classification
Title: Update version{added,changed} docs in devguide
Type: behavior Stage: resolved
Components: Devguide Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: berker.peksag, ezio.melotti, georg.brandl, python-dev, willingc
Priority: normal Keywords: patch

Created on 2016-04-14 09:38 by berker.peksag, last changed 2016-04-18 18:41 by berker.peksag. This issue is now closed.

Files
File name Uploaded Description Edit
versionchanged.diff berker.peksag, 2016-04-14 09:38
Messages (3)
msg263393 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2016-04-14 09:38
This is a follow-up from issue 26366:

    "the original intention was to use "versionadded" where the API item is completely new.  So "The parameter x was added" in a function is using "versionchanged" because only an aspect of the function's signature was changed."

See msg260314 and msg260509 for details.
msg263427 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2016-04-14 18:48
Now that "added" doesn't mention the second argument, the "This one *must* have the second argument (explanation of the change)." should be changed. Otherwise +1.
msg263681 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-04-18 18:41
New changeset 6ef3d77b3c27 by Berker Peksag in branch 'default':
Issue #26755: Clarify when version{added,changed} directives should be used in docs
https://hg.python.org/devguide/rev/6ef3d77b3c27
History
Date User Action Args
2016-04-18 18:41:43berker.peksagsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2016-04-18 18:41:29python-devsetnosy: + python-dev
messages: + msg263681
2016-04-14 18:48:19georg.brandlsetmessages: + msg263427
2016-04-14 09:38:44berker.peksagcreate