Skip to content

doc comment rewording #39482

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 8, 2017
Merged

doc comment rewording #39482

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c9fdd1
doc comment rewording
king6cong Feb 3, 2017
380ba6d
go back to use //
king6cong Feb 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/librustc/mir/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ macro_rules! newtype_index {
}

/// Lowered representation of a single function.
// Do not implement clone for Mir, its easy to do so accidently and its kind of expensive.
/// Do not implement clone for Mir, which can be accidently done and kind of expensive.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Regarding your // to /// change, I'm not sure if this information belongs in the doc comment. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, better to keep it out of doc comment. Thanks

#[derive(RustcEncodable, RustcDecodable, Debug)]
pub struct Mir<'tcx> {
/// List of basic blocks. References to basic block use a newtyped index type `BasicBlock`
Expand Down