gh-136897: Update docstring of str.translate
#136954
Conversation
This comment has been minimized.
This comment has been minimized.
|
All commit authors signed the Contributor License Agreement. |
This comment has been minimized.
This comment has been minimized.
str.translatestr.translate
|
In the future, please use the title format you had in the issues description. |
|
@StanFromIreland ok 🙌 |
| Translation table, which must be a mapping of Unicode ordinals to | ||
| Unicode ordinals, strings, or None. | ||
| Translation table, which must be an object that implements indexing via __getitem__(), | ||
| typically a mapping or sequence. |
There was a problem hiding this comment.
Please, explain "a mapping or sequence" of "what" :)
There was a problem hiding this comment.
It is like this in the docs, do we want to update it too?
There was a problem hiding this comment.
I can update both online docs(original one) and that docstring I've changed, shall we proceed with that ?
| Translation table, which must be a mapping of Unicode ordinals to | ||
| Unicode ordinals, strings, or None. |
There was a problem hiding this comment.
This original wording is clearer, it describes what the object is semantically, not just the type and protocol. "a mapping of ordinals to ..." is not necessarily the same as an object conforming to the Mapping protocol.
gh-136897: Update docstring of
str.translateAs mentioned in the issue, I've updated docstring to "match" it with online docs then ran
make clinic.