PYTHON-3445 Improve documentation for custom readPreference tags #1068
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
|
This PR also addresses the link failures in PYTHON-3455 |
blink1073
requested changes
Oct 5, 2022
README.rst
Outdated
| @@ -25,7 +25,7 @@ For issues with, questions about, or feedback for PyMongo, please look into | |||
| our `support channels <https://support.mongodb.com/welcome>`_. Please | |||
| do not email any of the PyMongo developers directly with issues or | |||
| questions - you're more likely to get an answer on the `MongoDB Community | |||
| Forums <https://developer.mongodb.com/community/forums/tag/python-driver>`_. | |||
| Forums <https://www.`mongodb.com/community/forums/`tag/python>`_. | |||
There was a problem hiding this comment.
There are two stray backticks in the link
ShaneHarvey
requested changes
Oct 5, 2022
pymongo/read_preferences.py
Outdated
|
|
||
| Nearest(tag_sets=[ | ||
| {"node":"analytics"} | ||
| ]) |
There was a problem hiding this comment.
Make this one line like below: Nearest(tag_sets=[{"node":"analytics"}])
Can you also add a similar SecondaryPreferred example?
ShaneHarvey
requested changes
Oct 6, 2022
pymongo/read_preferences.py
Outdated
| Nearest(tag_sets=[{"node":"analytics"}]) | ||
|
|
||
| This can also be done using SecondaryPreferred to ensure that | ||
| the queries are sent to secondary nodes:: |
There was a problem hiding this comment.
I worry "to ensure that the queries are sent to secondary nodes" is a little misleading since that's not the behavior of SecondaryPreferred, How about just:
For example, to only send a query to an analytic node::
Nearest(tag_sets=[{"node":"analytics"}])
Or using :class:`SecondaryPreferred`::
SecondaryPreferred(tag_sets=[{"node":"analytics"}])
ShaneHarvey
approved these changes
Oct 6, 2022
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.