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

Docs: promote the shelve module in the dbm docs introduction #126218

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

andresdelfino
Copy link
Contributor

@andresdelfino andresdelfino commented Oct 31, 2024

I believe the proposed modification lets the user know earlier if the module is useful to them and that shelve may help him/her if the dbm module is not enough.


📚 Documentation preview 📚: https://cpython-previews--126218.org.readthedocs.build/

@serhiy-storchaka
Copy link
Member

@rhettinger, do you like to look at this?

@erlend-aasland
Copy link
Contributor

There is already a .. seealso that points to shelve. If we are to make any changes, consider instead to make that reference more prominent, for example by moving it up to the introduction. IMO, that should be sufficient.

@andresdelfino
Copy link
Contributor Author

There is already a .. seealso that points to shelve. If we are to make any changes, consider instead to make that reference more prominent, for example by moving it up to the introduction. IMO, that should be sufficient.

Hmmm, the PR does also make that change. Perhaps I'm not understanding you correctly?

@erlend-aasland
Copy link
Contributor

Hmmm, the PR does also make that change. Perhaps I'm not understanding you correctly?

Sorry, my bad; I misread the PR to just add a new .. seealso. Yes, this particular change is fine with me.

Doc/library/dbm.rst Outdated Show resolved Hide resolved
@erlend-aasland erlend-aasland added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Nov 11, 2024
erlend-aasland
erlend-aasland previously approved these changes Nov 11, 2024
@erlend-aasland erlend-aasland changed the title Explain what a DBM database is and point to shelve earlier Docs: promote the shelve module in the dbm docs introduction Nov 11, 2024
@erlend-aasland erlend-aasland dismissed their stale review November 11, 2024 21:41

I think some amendments are needed

Doc/library/dbm.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes skip issue skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

4 participants