Skip to content

Update the dbm documentation #137919

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

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

Conversation

serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Aug 18, 2025

Unify documentation for all backends, enumerate all not implemented mapping methods, document particularities of implemented mapping methods.


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

Unify documentation for all backends, enumerate all not implemented mapping
methods, document particularities of implemented mapping methods.
Copy link
Member Author

@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.

I reordered methods because they order was inconsistent between classes.

I am not sure whether it is worth to document clear() methods for gdbm and ndbm (they are the part of the mutable mapping protocol) or just add the versionchanged` directives.

We may add other not yet implemented methods (pop, popitem, values, update) in future, as some mapping methods were added in the past.

Copy link

@auvipy auvipy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

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.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip issue skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

3 participants