-
Notifications
You must be signed in to change notification settings - Fork 20
DOCSP-41333 Version Release for 3.0 and 3.0.1 #123
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
DOCSP-41333 Version Release for 3.0 and 3.0.1 #123
Conversation
rustagir
left a comment
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.
A few small changes!
source/whats-new.txt
Outdated
| - Fixes issue where aggregations with both explicit sessions and custom types | ||
| wouldn't compile. |
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.
| - Fixes issue where aggregations with both explicit sessions and custom types | |
| wouldn't compile. | |
| - Fixes an issue in which aggregations run within explicit sessions and aggregation | |
| that used custom types wouldn't compile. |
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.
Based on the PR for this change, it seems like the issue is: "Aggregation with both an explicit session and a custom type isn't possible. While helpers for both with_type and session exist in the 3.0 API, it's impossible to use both on the same aggregation." I think the current suggestion seems to imply it's that both explicit sessions and custom types don't work individually. What do you think of:
Fixes an issue in which aggregations run within explicit sessions which also used custom types wouldn't compile.
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.
sounds good!
source/whats-new.txt
Outdated
| - Fixes issue where ``Collection::watch`` didn't use the ``Collection`` type | ||
| parameter. |
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.
| - Fixes issue where ``Collection::watch`` didn't use the ``Collection`` type | |
| parameter. | |
| - Fixes an issue in which the ``Collection::watch()`` method didn't | |
| use the type parameter of the ``Collection`` instance it was run on. |
source/whats-new.txt
Outdated
|
|
||
| To learn more about this release, see the | ||
| `v3.0.1 Release Notes | ||
| <https://github.com/mongodb/mongo-rust-driver/releases/tag/v3.0.1>`__ |
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.
S: let's move https://github.com/mongodb/mongo-rust-driver/ into a source constant and replace the link stem throughout the page with that constant
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.
It can be called "driver-source"
rustagir
left a comment
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 save a few small remaining suggestions!
source/whats-new.txt
Outdated
| The {+driver-short+} v3.0.1 release includes the following features, | ||
| improvements, and fixes: | ||
|
|
||
| - Fixes an issue in which aggregations run within explicit sessions which also used custom types wouldn't compile. |
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.
S: revisiting this wording, I think the subject and predicate are too far from each other. what about this?
| - Fixes an issue in which aggregations run within explicit sessions which also used custom types wouldn't compile. | |
| - Fixes an issue in which aggregations wouldn't compile when | |
| run within explicit sessions and also implemented custom types. |
snooty.toml
Outdated
| stable-api = "Stable API" | ||
| tracing-version = "0.1.37" | ||
| tracing-sub-version = "0.3.17" | ||
| driver-source = "https://github.com/mongodb/mongo-rust-driver/" |
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.
nit: remove the trailing slash at the end and adjust the usages of the source constant. This creates cleaner looking links than having the rest of the link directly abut the source constant brackets:
{+constant+}this/is/my/link vs {+constant+}/this/is/my/link
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-41333
Staging - https://preview-mongodbshuangela.gatsbyjs.io/rust/DOCSP-41333-rust-3.0-update/
This pr includes release notes/compat table/updates for both 3.0 and 3.0.1.
Self-Review Checklist