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

Jump to bottom
Merged
merged 3 commits into from
Apr 1, 2022
Merged

Improve docstrings for SON parameters #919

merged 3 commits into from
Apr 1, 2022

Conversation

dunkOnIT
Copy link
Contributor

@dunkOnIT dunkOnIT commented Apr 1, 2022

Line 1446 of this file originally read as follows:

"filter (optional): a SON object specifying elements..."

I believe "SON" is a typo for "JSON", so have updated it to read as follows:

"filter (optional): a JSON object specifying elements..."

@dunkOnIT
Corrected typo in documentation ("SON" > "JSON")
1c683fb 
Line 1446 of this file originally read as follows:
> "`filter` (optional): a SON object specifying elements..."

I believe "SON" is a typo for "JSON", so have updated it to read as follows:
> "`filter` (optional): a JSON object specifying elements..."
@blink1073
Copy link
Member

Hi @dunkOnIT, SON is a custom class in bson, effectively an ordered dictionary.

@dunkOnIT
Copy link
Contributor Author

dunkOnIT commented Apr 1, 2022

Haha! I did write this PR in fear that I would display my ignorance - a well-founded fear, it seems :P

There may be merit in disambiguating for newbies like me by linking to the bson documentation, although in practical terms I'm not sure how much additional value that provides.

Its something I'm happy to do if you feel it would add value, but I'm also comfortable if you close this issue.

Thanks!

@blink1073
Copy link
Member

blink1073 commented Apr 1, 2022 •
edited
Loading

Sounds good! It would be:

:class:`~bson.son.SON`

dunkOnIT added 2 commits April 1, 2022 17:25
@dunkOnIT
Changed SON instances to link to documentation
dfacef0 
Per advice in PR discussion - I searched for all instances of " SON", checked to make sure they were part of documentation and not code, and replaced with `:class:`~bson.son.SON``
@dunkOnIT
Removed a space I erroneously left on line 163
bd752e5 
(and learned about the power of "Preview changes" in the process!)
@blink1073 blink1073 changed the title Corrected typo in documentation ("SON" > "JSON") Improve docstrings for SON parameters Apr 1, 2022
blink1073
blink1073 approved these changes Apr 1, 2022
View reviewed changes
Copy link
Member

@blink1073 blink1073 left a comment

Choose a reason for hiding this comment

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

Thank you!

@blink1073
Copy link
Member

Test failure is being tracked in https://jira.mongodb.org/browse/PYTHON-3188

@dunkOnIT
Copy link
Contributor Author

dunkOnIT commented Apr 1, 2022

Thanks for the opportunity to contribute! (I presume test failures aren't for me to worry about, given that they predate this PR?)

@blink1073
Copy link
Member

(I presume test failures aren't for me to worry about, given that they predate this PR?)

That's right, we're already working on that one separately.

@blink1073 blink1073 merged commit b0fd5cb into mongodb:master Apr 1, 2022
juliusgeo pushed a commit to juliusgeo/mongo-python-driver that referenced this pull request Apr 7, 2022
@dunkOnIT @juliusgeo
Improve docstrings for SON parameters (mongodb#919)
0a72a98
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blink1073 blink1073 blink1073 approved these changes

@juliusgeo juliusgeo Awaiting requested review from juliusgeo

@ShaneHarvey ShaneHarvey Awaiting requested review from ShaneHarvey

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dunkOnIT @blink1073