-
-
Notifications
You must be signed in to change notification settings - Fork 33.3k
Docs: amend note about incompatible dbm file formats #114597
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
Docs: amend note about incompatible dbm file formats #114597
Conversation
|
This PR tries to address @serhiy-storchaka's concerns in #114549 (comment) |
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My concern is that the definition of incompat_note is far from its use. So the text of the note can be de-synchronized with the text to which it relates, especially if it is not identical in both cases.
Would it help if we named the placeholder |
I acknowledge that concern. OTOH, if we copy the sentences verbatim, there is also a concern that only one of them will be updated in a future amendment, and so they will desynchronise. I'm fine with either way. |
|
Sorry, wrong PR. |
|
The text of the note is related to the text of one or two paragraphs before it, which are different. It just happens that the text of this one sentence is the same in both cases. But if we reword the previous paragraphs, the text of the note should be reworded as well. First of all it should be consistent with the words in the same section, and only after this with a similar note in other section. |
📚 Documentation preview 📚: https://cpython-previews--114597.org.readthedocs.build/