RUST-736 Update documentation for 2.0 release #295
Merged
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
patrickfreed
commented
Aug 26, 2021
| [](https://crates.io/crates/bson) | ||
|
|
||
| Encoding and decoding support for BSON in Rust | ||
|
|
||
| ## Index | ||
| - [Installation](#installation) |
There was a problem hiding this comment.
the structure was updated to match the driver's readme
| impl<T: chrono::TimeZone> From<chrono::DateTime<T>> for Bson { | ||
| fn from(a: chrono::DateTime<T>) -> Bson { | ||
| Bson::DateTime(crate::DateTime::from(a)) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "uuid-0_8")] |
There was a problem hiding this comment.
I noticed this wasn't here after I tried to ensure my documentation examples compiled. For completeness, I just went ahead and implemented it (RUST-997).
|
|
||
| #![allow(clippy::cognitive_complexity)] | ||
| #![doc(html_root_url = "https://docs.rs/bson/2.0.0-beta.3")] | ||
| #![cfg_attr(docsrs, feature(doc_cfg))] |
There was a problem hiding this comment.
this allows us to display the little badges next to things that are behind feature flags
patrickfreed
commented
Aug 27, 2021
| @@ -7,3 +7,4 @@ use_try_shorthand = true | |||
| wrap_comments = true | |||
| imports_layout = "HorizontalVertical" | |||
| imports_granularity = "Crate" | |||
| ignore = ["src/lib.rs"] | |||
There was a problem hiding this comment.
rustfmt kept messing up the table that has the feature flags in it so I just had it skip lib.rs. Once rust-lang/rustfmt#4210 is released we should be able to remove this.
abr-egn
approved these changes
Aug 30, 2021
patrickfreed
force-pushed
the
RUST-736/document-for-2.0
branch
from
dbc930d to
6d621c0
Compare
isabelatkinson
approved these changes
Aug 31, 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 documentation to account for the 2.0 API, namely the
chronoanduuidchanges. As part of that, it also completes RUST-997.Some other housekeeping changes were made too:
#[doc(inline)]You can see all the new changes in action by running:
and comparing it to our latest documentation on docs.rs.