Skip to content

Improve docstrings for SON parameters #919

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

Merged
merged 3 commits into from
Apr 1, 2022
Merged

Improve docstrings for SON parameters #919

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c683fb
Corrected typo in documentation ("SON" > "JSON")
dunkOnIT Apr 1, 2022
dfacef0
Changed SON instances to link to documentation
dunkOnIT Apr 1, 2022
bd752e5
Removed a space I erroneously left on line 163
dunkOnIT Apr 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pymongo/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ def _command(

:Parameters:
- `sock_info` - A SocketInfo instance.
- `command` - The command itself, as a SON instance.
- `command` - The command itself, as a :class:`~bson.son.SON` instance.
- `codec_options` (optional) - An instance of
:class:`~bson.codec_options.CodecOptions`.
- `check`: raise OperationFailure if there are errors
Expand Down Expand Up @@ -1443,7 +1443,7 @@ def find(self, *args: Any, **kwargs: Any) -> Cursor[_DocumentType]:
this :class:`Collection`.

:Parameters:
- `filter` (optional): a SON object specifying elements which
- `filter` (optional): a :class:`~bson.son.SON` object specifying elements which
must be present for a document to be included in the
result set
- `projection` (optional): a list of field names that should be
Expand Down