Description
While reviewing the PR for #115652 I noticed other errors in multiprocessing.rst: incorrect order of versionchanged directives, using versionadded instead of versionchanged, 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
- gh-115664: Fix versionadded and versionchanged directives in multiprocessing.rst #115665
- gh-115664: Fix chronological ordering of versionadded and versionchanged directives #115676
- [3.12] gh-115664: Fix versionadded and versionchanged directives in multiprocessing.rst (GH-115665) #115677
- [3.12] gh-115664: Fix chronological ordering of versionadded and versionchanged directives (GH-115676) #115678
- [3.11] gh-115664: Fix chronological ordering of versionadded and versionchanged directives (GH-115676) #115681
- [3.11] gh-115664: Fix versionadded and versionchanged directives in multiprocessing.rst (GH-115665) #115682
- gh-115664: Fix ordering of more versionadded and versionchanged directives #116298
- gh-115664: Reorganize versionadded directives for -X options #116304
- [3.12] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) #116450
- [3.11] gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298) (GH-116450) #116452
- gh-115664: Merge versionchanged directives for the same version #116456
- [3.12] gh-115664: Reorganize versionadded directives for -X options (GH-116304) #117900