gh-98657: [docs] array.typecodes is a module-level attribute
#98729
Conversation
This file contains 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
nanjekyejoannah
approved these changes
Oct 28, 2022
nanjekyejoannah
reviewed
Oct 28, 2022
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 |
gvanrossum
pushed a commit
to gvanrossum/cpython
that referenced
this pull request
Oct 28, 2022
…ython#98729) * pythongh-98657: [docs] `array.typecodes` is a module-level attribute * Update array.rst
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.
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