Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 3 commits into from
+4 −6

Conversation

andresdelfino
Copy link
Contributor

@andresdelfino andresdelfino commented Oct 31, 2024 •
edited by github-actions bot
Loading

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/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Oct 31, 2024
@serhiy-storchaka
Copy link
Member

@rhettinger, do you like to look at this?

serhiy-storchaka
serhiy-storchaka reviewed Oct 31, 2024
View reviewed changes
@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.

erlend-aasland
erlend-aasland reviewed Oct 31, 2024
View reviewed changes
@erlend-aasland erlend-aasland added needs backport to 3.12 only 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
View reviewed changes
@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

erlend-aasland
erlend-aasland reviewed Nov 11, 2024
View reviewed changes
@hugovk hugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
@andresdelfino
Copy link
Contributor Author

Should I close this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka left review comments

@erlend-aasland erlend-aasland erlend-aasland left review comments

@corona10 corona10 Awaiting requested review from corona10 corona10 is a code owner

Assignees
No one assigned
Labels
awaiting review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip issue skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@andresdelfino @serhiy-storchaka @erlend-aasland @hugovk @skirpichev
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy