Skip to content

Conversation

@erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jan 26, 2024

@erlend-aasland
Copy link
Contributor Author

This PR tries to address @serhiy-storchaka's concerns in #114549 (comment)

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a 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.

@erlend-aasland
Copy link
Contributor Author

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 ndbm_gdbm_incompat_note instead of incompat_note?

@erlend-aasland
Copy link
Contributor Author

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.

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.

@serhiy-storchaka
Copy link
Member

Sorry, wrong PR.

@serhiy-storchaka
Copy link
Member

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.

@erlend-aasland erlend-aasland deleted the docs/dbm-incompatible-file-formats branch February 14, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes skip issue skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants