-
-
Notifications
You must be signed in to change notification settings - Fork 29.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix the use of versionadded and versionchanged directives #115664
Comments
serhiy-storchaka
added
docs
Documentation in the Doc dir
3.11
only security fixes
3.12
bugs and security fixes
3.13
bugs and security fixes
labels
Feb 19, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Feb 19, 2024
…ltiprocessing.rst
AlexWaygood
pushed a commit
that referenced
this issue
Feb 19, 2024
serhiy-storchaka
added a commit
that referenced
this issue
Feb 19, 2024
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Feb 19, 2024
…ltiprocessing.rst (pythonGH-115665) (cherry picked from commit 8f60298) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
brianschubert
added a commit
to brianschubert/cpython
that referenced
this issue
Feb 19, 2024
…d versionchanged directives (pythonGH-115676) (cherry picked from commit b02ab65) Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
AlexWaygood
pushed a commit
that referenced
this issue
Feb 19, 2024
serhiy-storchaka
added a commit
that referenced
this issue
Feb 19, 2024
brianschubert
added a commit
to brianschubert/cpython
that referenced
this issue
Feb 19, 2024
…d versionchanged directives (pythonGH-115676) (cherry picked from commit b02ab65) Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Feb 19, 2024
…s in multiprocessing.rst (pythonGH-115665) (cherry picked from commit 8f60298) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
AlexWaygood
pushed a commit
that referenced
this issue
Feb 19, 2024
serhiy-storchaka
added a commit
that referenced
this issue
Feb 19, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Mar 4, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Mar 4, 2024
Add the versionadded directives just under the description of the corresponding option.
woodruffw
pushed a commit
to woodruffw-forks/cpython
that referenced
this issue
Mar 4, 2024
…onchanged directives (python#115676)
woodruffw
pushed a commit
to woodruffw-forks/cpython
that referenced
this issue
Mar 4, 2024
…ltiprocessing.rst (pythonGH-115665)
serhiy-storchaka
added a commit
that referenced
this issue
Mar 7, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Mar 7, 2024
…changed directives (pythonGH-116298) (cherry picked from commit 808a776) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka
added a commit
that referenced
this issue
Mar 7, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Mar 7, 2024
…versionchanged directives (pythonGH-116298) (pythonGH-116450) (cherry picked from commit 1e75fe1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit 808a776)
serhiy-storchaka
added a commit
that referenced
this issue
Mar 7, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Mar 7, 2024
adorilson
pushed a commit
to adorilson/cpython
that referenced
this issue
Mar 25, 2024
serhiy-storchaka
added a commit
that referenced
this issue
Apr 15, 2024
Add the versionadded directives just under the description of the corresponding option.
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Apr 15, 2024
…ions (pythonGH-116304) Add the versionadded directives just under the description of the corresponding option. (cherry picked from commit 10f1a26) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka
added a commit
that referenced
this issue
Apr 15, 2024
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this issue
Apr 17, 2024
…onchanged directives (python#115676)
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this issue
Apr 17, 2024
…ltiprocessing.rst (pythonGH-115665)
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this issue
Apr 17, 2024
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this issue
Apr 17, 2024
…ythonGH-116304) Add the versionadded directives just under the description of the corresponding option.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
While reviewing the PR for #115652 I noticed other errors in multiprocessing.rst: incorrect order of
versionchanged
directives, usingversionadded
instead ofversionchanged
, misusing the term "argument" instead of "parameter". Then I tried to search similar errors in other files, and found tens possible candidates. So I opened an issue to fix all these errors.versionadded
indicates when the entity (module, class, function, method, attribute, etc) was added. It should be aligned with the description of the entity.versionchanged
indicates when the behavior of the entity was changed, including adding or removal of parameters or support of protocols. When a new parameter is added to the function or when the class starts supporting the context manager protocol,versionchanged
should be used. If a new attribute or method was added, but they do not have their own entry,versionchanged
can be used, applied to the parent class.Linked PRs
The text was updated successfully, but these errors were encountered: