gh-98657: [docs] array.typecodes is a module-level attribute
#98729
Conversation
Doc/library/array.rst
Outdated
| @@ -62,6 +62,14 @@ The actual representation of values is determined by the machine architecture | |||
| (strictly speaking, by the C implementation). The actual size can be accessed | |||
| through the :attr:`itemsize` attribute. | |||
|
|
|||
| The module defines the following items: | |||
There was a problem hiding this comment.
Why the plural "items" here, yet it is just one? And yet the type is correctly singularized. I think we can be consistent, the singular wording looks more appropriate.
|
Thanks for your contribution @sobolevn |
…ython#98729) * pythongh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst
CAM-Gerlach
added
needs backport to 3.10
|
Thanks @sobolevn for the PR, and @nanjekyejoannah for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11. |
|
Thanks @sobolevn for the PR, and @nanjekyejoannah for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10. |
…ythonGH-98729) * pythongh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst (cherry picked from commit c144e57) Co-authored-by: Nikita Sobolev <[email protected]>
…ythonGH-98729) * pythongh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst (cherry picked from commit c144e57) Co-authored-by: Nikita Sobolev <[email protected]>
|
GH-101484 is a backport of this pull request to the 3.10 branch. |
|
As it fixes a docs defect, applies to all supported versions, avoids future reports like #100925 against the stable docs, and blocks other PRs (namely #101485 ) from being cleanly backported, I marked it for backport as well per standard docs team policy. Could @nanjekyejoannah or another core dev help me merge them, please? For completeness, they are (since Bedevere didn't link one): |
|
GH-101483 is a backport of this pull request to the 3.11 branch. |
) * gh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst (cherry picked from commit c144e57) Co-authored-by: Nikita Sobolev <[email protected]>
) * gh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst (cherry picked from commit c144e57) Co-authored-by: Nikita Sobolev <[email protected]>
It is defined on a module-level and should be documented as such:
Typeshed definition: https://github.com/python/typeshed/blob/fd75bc21fca7d62235bdd2063ce65cdddbd40a1a/stdlib/array.pyi#L16
array.typecodesis incorrectly documented as a class attribute #98657