-
-
Notifications
You must be signed in to change notification settings - Fork 32.6k
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
base: main
Are you sure you want to change the base?
Update the dbm documentation #137919
Conversation
Unify documentation for all backends, enumerate all not implemented mapping methods, document particularities of implemented mapping methods.
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.
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.
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.
lgtm
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/