-
Notifications
You must be signed in to change notification settings - Fork 1.1k
PYTHON-5111 Update datetime_conversion in docstrings of MongoClients #2135
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
Conversation
… cleaned up formatting of last param
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
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.
There have been no code changes since my last review.
That's right. What I am saying is that Sphinx adds a carriage return to the last :param. This was how it was before, too. My picture shows the docs as they have existing for however long. When I moved datetime_conversion down, this weird behavior appears for :param type_registry. This is why I added :param kwargs, specifically because it included a big indented list before. There previously was a bold line, but it was redundant if any text was added to kwargs. Suggestions are welcome, given the constraint. I'm pretty happy with how it looks now. |
Oh I get it now. Could we at least add a colon and bold "Additional optional parameters available as keyword arguments:". That would better match with the other sections like "Write Concern options:" |
@ShaneHarvey Done. Bold with colon. |
Reflects the fact that it is now in kwargs.