make Step doc-comments more clear
#130965
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
|
rustbot has assigned @Mark-Simulacrum. Use |
rustbot
added
S-waiting-on-review
onur-ozkan
force-pushed
the
bootstrap-step-trait-doc
branch
4 times, most recently
from
d5bdc05 to
08d3378
Compare
jieyouxu
approved these changes
Sep 28, 2024
Comment on lines
+93
to
+97
| /// - First in "dry-run" mode to validate certain things (like cyclic Step invocations, | ||
| /// directory creation, etc) super quickly. | ||
| /// - Then it's called again to run the actual, very expensive process. |
There was a problem hiding this comment.
Remark: I almost wonder if this wants to be split into dry_run and run instead of always having to remember checking if dry_run { ... } lol. Implementation details shared between dry_run and run can always be shared by delegating repeated parts to other methods on the impl Step for $StepName { } impl block.
onur-ozkan
force-pushed
the
bootstrap-step-trait-doc
branch
3 times, most recently
from
33614fd to
8d92b44
Compare
jieyouxu
approved these changes
Sep 28, 2024
Signed-off-by: onur-ozkan <work@onurozkan.dev>
onur-ozkan
force-pushed
the
bootstrap-step-trait-doc
branch
from
8d92b44 to
8ef0ba2
Compare
|
@bors r+ |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Oct 12, 2024
…c, r=Mark-Simulacrum make `Step` doc-comments more clear Aiming to improve complicated `Step` documentation. Once we merge this, I will update [this page](https://rustc-dev-guide.rust-lang.org/building/bootstrapping/how-bootstrap-does-it.html?highlight=Step#synopsis-of--step) too.
This was referenced Oct 12, 2024
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 12, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#128784 (Check ABI target compatibility for function pointers) - rust-lang#130965 (make `Step` doc-comments more clear) - rust-lang#131239 (Don't assume traits used as type are trait objs in 2021 edition) - rust-lang#131277 (Handle `clippy` cases of `rustc::potential_query_instability` lint) - rust-lang#131503 (More clearly document Stdin::read_line) - rust-lang#131567 (Emit an error for unstable attributes that reference already stable features) - rust-lang#131599 (Shallowly match opaque key in storage) - rust-lang#131617 (remove const_cow_is_borrowed feature gate) Failed merges: - rust-lang#131616 (merge const_ipv4 / const_ipv6 feature gate into 'ip' feature gate) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 13, 2024
Rollup merge of rust-lang#130965 - onur-ozkan:bootstrap-step-trait-doc, r=Mark-Simulacrum make `Step` doc-comments more clear Aiming to improve complicated `Step` documentation. Once we merge this, I will update [this page](https://rustc-dev-guide.rust-lang.org/building/bootstrapping/how-bootstrap-does-it.html?highlight=Step#synopsis-of--step) too.
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.
Aiming to improve complicated
Stepdocumentation. Once we merge this, I will update this page too.