gh-100925: Move array methods under class in array doc #101485
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CAM-Gerlach
added
docs
ezio-melotti
approved these changes
Feb 1, 2023
JelleZijlstra
approved these changes
Feb 1, 2023
|
@ezio-melotti @JelleZijlstra thanks for the reviews here; would one of you be able to help merge the prior backports to unblock this? Thanks! |
|
Looks like this is ready @JelleZijlstra and @ezio-melotti Thanks for your help here! |
|
Thanks @CAM-Gerlach for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
|
GH-101527 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Feb 3, 2023
…H-101485) * Move array methods under class in array doc * Fix a few internal references related to the touched lines (cherry picked from commit 1b60456) Co-authored-by: C.A.M. Gerlach <[email protected]>
|
GH-101528 is a backport of this pull request to the 3.10 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Feb 3, 2023
…H-101485) * Move array methods under class in array doc * Fix a few internal references related to the touched lines (cherry picked from commit 1b60456) Co-authored-by: C.A.M. Gerlach <[email protected]>
miss-islington
added a commit
that referenced
this pull request
Feb 3, 2023
* Move array methods under class in array doc * Fix a few internal references related to the touched lines (cherry picked from commit 1b60456) Co-authored-by: C.A.M. Gerlach <[email protected]>
miss-islington
added a commit
that referenced
this pull request
Feb 3, 2023
* Move array methods under class in array doc * Fix a few internal references related to the touched lines (cherry picked from commit 1b60456) Co-authored-by: C.A.M. Gerlach <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes the issue reported in #100925 , where the attributes and methods of the
array.arrayclass are listed under the module rather than the class, and not clearly indicated as such, which is confusing to readers. This supersedes #101239 , which didn't quite solve the right problem; thanks @theWiseAman for your original PR that prompted this.Also a followup to #98657 , which just fixed this for the one module-level attribute. As both of these are a fix to a docs defect that applies to all supported versions, ensures the stable version will be updated to avoid more reports like the one that prompted this one, and allows future PRs to be cleanly backported, I've queued up backports for both that PR, #98729 and this one, the latter of which should be merged first before this PR is, so that miss-islington can do the backports of this one cleanly:
array.typecodesis a module-level attribute (GH-98729) #101483array.typecodesis a module-level attribute (GH-98729) #101484To note, since the class name was included in the existing
method/attributedirectives, this change doesn't break any internal or Intersphinx links, and also maintains the same fragment ids, so external links will continue to work exactly the same as before. Therefore, I've confirmed it is fully backward-compatible.Closes #101239