RUST-736 Update driver documentation for 2.0 release #437
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| //! your application, simply add it to your project's `Cargo.toml`. | ||
| //! ```toml | ||
| //! [dependencies] | ||
| //! mongodb = "2.0.0-beta.3" |
There was a problem hiding this comment.
Should this be "2.0.0" since we're doing this as part of the 2.0 release? (ditto other places with this version string)
There was a problem hiding this comment.
I was going to leave them as 2.0.0-beta.3 for now since that's the latest released version, and then update them right before the actual 2.0.0 release. This is usually what I've done for prior betas.
src/lib.rs
Outdated
| //! | `async-std-runtime` | Enable support for the `async-std` runtime | `async-std` 1.0 | no | | ||
| //! | `sync` | Expose the synchronous API (`mongodb::sync`). This flag cannot be used in conjunction with either of the async runtime feature flags. | `async-std` 1.0 | no | | ||
| //! | `aws-auth` | Enable support for the MONGODB-AWS authentication mechanism. | `reqwest` 0.11 | no | | ||
| //! | `bson-u2i` | Enable the `u2i` feature flag of the re-exported `bson` crate. | n/a | no | |
There was a problem hiding this comment.
If we go ahead with RUST-968 we should remove this.
abr-egn
approved these changes
Aug 30, 2021
isabelatkinson
approved these changes
Aug 30, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RUST-736
This PR updates the crate's documentation (found in
lib.rs) to include the 2.0-friendly examples found in the readme. It also adds a table to both the readme and the crate documentation that lists and explains all of the feature flags. Finally, some more guidance was added to theCollectiondocumentation about how to use its generic parameter.To view the new changes locally, you can run
cargo doc --no-deps --open.