Prefer doc comments over //-comments in compiler
#104976
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
|
r? @cjgillot (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
A-query-system
|
Some changes occurred to the CTFE / Miri engine cc @rust-lang/miri Some changes occurred to MIR optimizations cc @rust-lang/wg-mir-opt Some changes occurred in compiler/rustc_codegen_cranelift cc @bjorn3 Some changes occurred in compiler/rustc_codegen_gcc cc @antoyo Some changes occurred to the CTFE / Miri engine cc @rust-lang/miri These commits modify compiler targets. |
|
@bors r+ |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 28, 2022
…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#104955 (Switch rustdoc-gui test to function call) - rust-lang#104976 (Prefer doc comments over `//`-comments in compiler) - rust-lang#104984 (Remove Crate::primitives field) - rust-lang#104989 (update Miri) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Aaron1011
pushed a commit
to Aaron1011/rust
that referenced
this pull request
Jan 6, 2023
…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#104955 (Switch rustdoc-gui test to function call) - rust-lang#104976 (Prefer doc comments over `//`-comments in compiler) - rust-lang#104984 (Remove Crate::primitives field) - rust-lang#104989 (update Miri) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
antoyo
pushed a commit
to antoyo/rust
that referenced
this pull request
Jun 19, 2023
…llot Prefer doc comments over `//`-comments in compiler Doc comments are generally nicer: they show up in the documentation, they are shown in IDEs when you hover other mentions of items, etc. Thus it makes sense to use them instead of `//`-comments.
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.
Doc comments are generally nicer: they show up in the documentation, they are shown in IDEs when you hover other mentions of items, etc. Thus it makes sense to use them instead of
//-comments.