File tree Expand file tree Collapse file tree 1 file changed +14
-1
lines changed Expand file tree Collapse file tree 1 file changed +14
-1
lines changed Original file line number Diff line number Diff line change @@ -1063,7 +1063,20 @@ Cargo.toml should contain a note next to the version to remember to bump the
1063
1063
<a id =" c-docs-rs " ></a >
1064
1064
### Cargo.toml documentation key points to docs.rs (C-DOCS-RS)
1065
1065
1066
- It should point to ` "https://docs.rs/$crate" ` .
1066
+ In most cases the ` documentation ` key in a crate's ` Cargo.toml ` should
1067
+ be ` "https://docs.rs/$crate" ` .
1068
+
1069
+ [ docs.rs] provides automatic hosting of crate documentation, with a
1070
+ consistent style, inter-crate navigation, and advanced features not
1071
+ included in the stock rustdoc output. It is a central destination for
1072
+ documentation of all Rust crates. Rust users are familiar with docs.rs
1073
+ and expect to go there for their API documentation. A crate that
1074
+ directs their users to a different site for its documentation will be
1075
+ noticably segregating itself from the larger portion of the
1076
+ ecosystem. This may be desirable to crate authors in some situations
1077
+ but should be considered carefully.
1078
+
1079
+ [ docs.rs ] : https://docs.rs
1067
1080
1068
1081
[ C-RELNOTES ] : #c-relnotes
1069
1082
<a id =" c-relnotes " ></a >
You can’t perform that action at this time.
0 commit comments