Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-106318: Add string method examples #119445

Draft
wants to merge 67 commits into
base: main
Choose a base branch
from
Draft

Conversation

blaisep
Copy link
Contributor

@blaisep blaisep commented May 22, 2024

This PR reformats the examples created by @adorilson in #105670
I followed the discussion in a related PR #111743 , and then discussed it with @encukou and @CAM-Gerlach .
We decided that the fastest way to get the content into the docs was to edit the stdtypes.rst to include various suggestions and to have me update the related PR
So I pulled the branch, resolved merge conflicts, edited the file and created this PR.

Mentioning others who might be interested:
@hauntsaninja , @CAM-Gerlach , @encukou


📚 Documentation preview 📚: https://cpython-previews--119445.org.readthedocs.build/en/119445/library/stdtypes.html

adorilson added 30 commits June 11, 2023 19:43
@blaisep blaisep marked this pull request as ready for review May 28, 2024 07:05
Doc/library/stdtypes.rst Show resolved Hide resolved
Doc/library/stdtypes.rst Show resolved Hide resolved
Doc/library/stdtypes.rst Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
>>> 'Python'.rjust(10, '.')
'....Python'

The original string is returned if *width* is less than or equal to ``len(s)``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this might fix the Sphinx error:

Suggested change
The original string is returned if *width* is less than or equal to ``len(s)``.
The original string is returned if *width* is less than or equal to ``len(s)``.

For some reason, reST is usually indented in multiples of 3 spaces.

@blaisep blaisep marked this pull request as draft June 6, 2024 23:44
@blaisep
Copy link
Contributor Author

blaisep commented Jun 7, 2024

I'll update this with the suggestions from https://www.youtube.com/live/-0SXSTkJsfg?si=yRQG9Pm0ochACy_x&t=3883

Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Doc/library/stdtypes.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@adorilson adorilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I notice some possible errors, @blaisep

@blaisep
Copy link
Contributor Author

blaisep commented Jun 13, 2024

I notice some possible errors, @blaisep

Yes, I am marking this draft and going over it much more carefully. BTW, @adorilson , I will be in UTC-4 for the rest of the week and happy to pair up on this if you like. I'll add you to my fork.

Fix doctest formatting errors
@@ -1863,7 +1857,7 @@ expression support in the :mod:`re` module).
... def __missing__(self, key):
... return key
...
>>> '{name} was born in {country}'.format_map(Default(name='Guido'))
>>> '{name} was born in {country}'.format_map(Default(name='Guido', country='Netherlands'))
'Guido was born in country'
Copy link
Contributor

@adorilson adorilson Jul 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is supposed to be:

'Guido was born in Netherlands'

However, I think the previous example is more valuable. It shows the two Default class behaviour.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

6 participants