Skip to content

Add missing version info for 1.3.0 release #486

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

Merged
merged 4 commits into from
Feb 6, 2018

Conversation

jmikola
Copy link
Member

@jmikola jmikola commented Feb 6, 2018

I took a look through docs changes in the diff between v1.2 and master and I believe this is everything.

Tested with a local docs build.

@jmikola jmikola requested a review from kvwalker February 6, 2018 21:23
.. versionadded:: 1.3

.. default-domain:: mongodb
Copy link
Member Author

Choose a reason for hiding this comment

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

This rendered fine before. Just re-ordering it for consistency with other RST files.

MongoDB\\Collection::watch()
================================
============================
Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't notice build warnings for the previous header lines (not sure if strict warnings are being suppressed), but it is something RST can sometimes complain about so this was a quick fix.

@@ -5,6 +5,8 @@ source:
source:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should maxTimeMS also show versionadded:: 1.3 here and in dropIndexes-option??

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, I missed 3e83aa7. Thanks for catching that!

@@ -70,6 +70,8 @@ optional: true
source:
file: apiargs-common-option.yaml
ref: session
post: |
.. versionadded:: 1.3
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you need to specify this here even though every option here was added in version 1.3 since Watch is new?

Copy link
Member Author

Choose a reason for hiding this comment

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

Definitely not. This was likely the result of an over aggressive search/replace.

Noting version info on a per-method basis keeps this flexible if another method end up using the option in some later version.
This also fixes RST formatting for header lengths.
@jmikola jmikola merged commit 9dc7918 into mongodb:master Feb 6, 2018
jmikola added a commit that referenced this pull request Feb 6, 2018
@jmikola jmikola deleted the docs-versionadded branch February 6, 2018 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants