-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-134946 docs: fix formatting in dataclasses.rst #134948
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-134946 docs: fix formatting in dataclasses.rst #134948
Conversation
9eb96a7
to
7f75826
Compare
45ec776
to
2d59921
Compare
Correct boolean literals by replacing 'true' with '``True``' for accuracy and consistency. Resolves pythongh-134946
2d59921
to
060dd93
Compare
There are similar cases on lines 117, 154 and 155. Would you mind fixing them too? |
The original intent was to differentiate between All of the ones that were changed to "If |
Hi @ericvsmith 👋 , thanks for the clarification. if I understood correctly, then there is only one occurrence to be changed: unsafe_hash: If Is this correct? |
I think the correct change is: if false (the default is |
Note: I already have an open PR for this: #116532 (although not taking the same approach). |
Maybe they should all be rewritten so that they describe the behavior if the flag is set, not ever if the flag has a "falsy" value. Then at the end, put the default value. So they'd all become something like "If true, then <whatever>. The default value is At this point I suggest someone from the documentation group take a look, or just leave it as it is. |
I don't this PR adds anything, would suggest closing. A |
Correct boolean literals by replacing 'true' with '
True
' for accuracy and consistency.Fixes gh-134946
📚 Documentation preview 📚: https://cpython-previews--134948.org.readthedocs.build/