Skip to content

Conversation

@shuangela
Copy link
Collaborator

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

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link
Contributor

@rustagir rustagir left a 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!

Comment on lines 37 to 38
- Fixes issue where aggregations with both explicit sessions and custom types
wouldn't compile.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- 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.

Copy link
Collaborator Author

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

sounds good!

Comment on lines 40 to 41
- Fixes issue where ``Collection::watch`` didn't use the ``Collection`` type
parameter.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- 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.


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>`__
Copy link
Contributor

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

Copy link
Contributor

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"

Copy link
Contributor

@rustagir rustagir left a 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!

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.
Copy link
Contributor

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?

Suggested change
- 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/"
Copy link
Contributor

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

@shuangela shuangela merged commit cd9ab5d into mongodb:master Jul 10, 2024
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