PYTHON-3445 Improve documentation for with_options #1074
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
blink1073
requested changes
Oct 12, 2022
pymongo/database.py
Outdated
| @@ -162,7 +162,11 @@ def with_options( | |||
| >>> db1.read_preference | |||
| Primary() | |||
| >>> from pymongo import ReadPreference | |||
| >>> db2 = db1.with_options(read_preference=ReadPreference.SECONDARY) | |||
| >>> db2 = db1.with_options( | |||
| read_preference=Secondary(tag_sets=[..]), | |||
There was a problem hiding this comment.
We should put actual values in here for demonstration purposes
There was a problem hiding this comment.
+1 like:
>>> from pymongo.read_preferences import Secondary
>>> db2 = db1.with_options(read_preference=Secondary(tag_sets=[{"node":"analytics"}]))
>>> db1.read_preference
Primary()
>>> db2.read_preference
Secondary(tag_sets=[{'node': 'analytics'}], max_staleness=-1, hedge=None)
ShaneHarvey
requested changes
Oct 12, 2022
pymongo/database.py
Outdated
| read_preference=Secondary([{'node': 'analytics'}]), | ||
| write_concern=WriteConcern(w="majority"), | ||
| read_concern=ReadConcern(level="majority"), | ||
| ) |
There was a problem hiding this comment.
This formatting does not look good in the docs. Let's just remove write_concern and read_concern so it can fit on one line: https://pymongo--1074.org.readthedocs.build/en/1074/api/pymongo/database.html#pymongo.database.Database.with_options
ShaneHarvey
approved these changes
Oct 12, 2022
ShaneHarvey
requested changes
Oct 12, 2022
| @@ -162,11 +162,11 @@ def with_options( | |||
| >>> db1.read_preference | |||
| Primary() | |||
| >>> from pymongo import ReadPreference | |||
There was a problem hiding this comment.
Sorry this is still missing the import for Secondary
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.