feat: add sentence about rustdoc & std library #1322
Merged
Conversation
This file contains 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
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @marioidival (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
jsjoeio
commented
Mar 25, 2020
| @@ -65,6 +65,8 @@ $ rustc doc.rs --crate-type lib | |||
| $ rustdoc --test --extern doc="libdoc.rlib" doc.rs | |||
| ``` | |||
|
|
|||
| For documentation, `rustdoc` is widely used by the community. It's what is used to generate the [std library docs](https://doc.rust-lang.org/std/). | |||
There was a problem hiding this comment.
Is the technically accurate?
6 tasks
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Mar 31, 2020
Update books. ## reference 2 commits in e2f11fe..89dd146 2020-03-10 06:59:24 +0100 to 2020-03-31 09:42:10 -0700 - Clarify rule for end-of-line backslashes in strings (rust-lang/reference#784) - Fix and clarify section on re-export (rust-lang/reference#780) ## book 1 commits in 6fb3705e5230311b096d47f7e2c91f9ce24393d0..c8841f2841a2d26124319ddadd1b6a245f9a1856 2020-02-12 13:48:57 -0500 to 2020-03-22 09:07:01 -0500 - Fix broken front_of_house.rs test on nightly. (rust-lang/book#2289) ## rust-by-example 7 commits in cb369ae95ca36b841960182d26f6d5d9b2e3cc18..edd2a7e687358712608896730c083cb76c7b401a 2020-03-14 12:13:22 -0500 to 2020-03-30 09:37:29 -0300 - feat: add doc attributes section to documentation (rust-lang/rust-by-example#1323) - feat: add playpen topic (rust-lang/rust-by-example#1324) - feat: add sentence about rustdoc & std library (rust-lang/rust-by-example#1322) - fix: make spelling/style of rustdoc consistent (rust-lang/rust-by-example#1321) - Rewrite section on 'static lifetime. (rust-lang/rust-by-example#1320) - Remove deprecated `std::error::Error` functions and other minor changes (rust-lang/rust-by-example#1319) - Remove mdbook version flags from README (rust-lang/rust-by-example#1318) ## nomicon 1 commits in 9f797e65e6bcc79419975b17aff8e21c9adc039f..411197b0e77590c967e37e8f6ec681abd359afe8 2020-03-04 03:45:13 +0100 to 2020-03-31 20:46:09 +0200 - Fix negative_impls feature. (rust-lang/nomicon#205)
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Mar 31, 2020
Update books. ## reference 2 commits in e2f11fe..89dd146 2020-03-10 06:59:24 +0100 to 2020-03-31 09:42:10 -0700 - Clarify rule for end-of-line backslashes in strings (rust-lang/reference#784) - Fix and clarify section on re-export (rust-lang/reference#780) ## book 1 commits in 6fb3705e5230311b096d47f7e2c91f9ce24393d0..c8841f2841a2d26124319ddadd1b6a245f9a1856 2020-02-12 13:48:57 -0500 to 2020-03-22 09:07:01 -0500 - Fix broken front_of_house.rs test on nightly. (rust-lang/book#2289) ## rust-by-example 7 commits in cb369ae95ca36b841960182d26f6d5d9b2e3cc18..edd2a7e687358712608896730c083cb76c7b401a 2020-03-14 12:13:22 -0500 to 2020-03-30 09:37:29 -0300 - feat: add doc attributes section to documentation (rust-lang/rust-by-example#1323) - feat: add playpen topic (rust-lang/rust-by-example#1324) - feat: add sentence about rustdoc & std library (rust-lang/rust-by-example#1322) - fix: make spelling/style of rustdoc consistent (rust-lang/rust-by-example#1321) - Rewrite section on 'static lifetime. (rust-lang/rust-by-example#1320) - Remove deprecated `std::error::Error` functions and other minor changes (rust-lang/rust-by-example#1319) - Remove mdbook version flags from README (rust-lang/rust-by-example#1318) ## nomicon 1 commits in 9f797e65e6bcc79419975b17aff8e21c9adc039f..411197b0e77590c967e37e8f6ec681abd359afe8 2020-03-04 03:45:13 +0100 to 2020-03-31 20:46:09 +0200 - Fix negative_impls feature. (rust-lang/nomicon#205)
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.
One of the suggestions in #108 was mentioning:
The goal of the PR is to accomplish that by adding a short sentence to the "Documentation" topic in RBE.