-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Various cosmetic improvements #6673
Conversation
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Eh2406 (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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ran out of time. Some initial comments/questions.
@@ -58,7 +58,7 @@ the local hard drive. | |||
|
|||
`Resolve` is the representation of a directed acyclic graph of package | |||
dependencies, which uses `PackageId`s for nodes. This is the data | |||
structure that is saved to the lock file. If there is no lockfile, | |||
structure that is saved to the lock file. If there is no lock file, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we prefer "lockfile" or "lock file"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just normalised to the more common variant; otherwise ambivalent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I can believe that. I think I've been using lockfile, but I'm happy with a decision and applying it uniformly.
pub fn is_check(self) -> bool { | ||
match self { | ||
CompileMode::Check { .. } => true, | ||
_ => false, | ||
} | ||
} | ||
|
||
/// Returns true if this is a doc or doctest. Be careful using this. | ||
/// Returns `true` if this is a doc or doc test. Be careful using this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we prefer "doctest" or "doc test"?
pub force_rebuild: bool, | ||
/// Output a build plan to stdout instead of actually compiling. | ||
pub build_plan: bool, | ||
/// Use Cargo itself as the wrapper around rustc, only used for `cargo fix` | ||
/// Use Cargo itself as the wrapper around rustc, only used for `cargo fix`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we prefer doc comments to end in full stops?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Finished reviewing. There are some mistakes to fix and some more comments/questions. The "E.g.," (and "I.e.,") still look wrong to me, and I'd prefer something else. Also I think we can keep git as "git" unless it starts a sentence or phrase. Finally we're a bit inconsistent on how we format GitHub URLs and URLs in general, but I don't mind what we do there.
@dwijnand Thanks for the review. Pushed a bunch of fixes. Hopefully we're either ready to merge now or very close. :-) |
@alexreg want to get CI passing? Then I'll give this a final review and hopefully/ideally land it. |
@dwijnand Ah sorry, should be done now... |
There was a trailing unused import, so I think this should pass now. |
@alexreg something broke with this PR. I've repushed my test-fixing commit, which you can see on your branch, but it's not showing up here in the PR and Travis CI didn't get it either. I think you should open a new PR and hopefully it doesn't break again :) |
Resubmitted as #6687. |
Related to the larger effort of rust-lang/rust#58036.