Skip to content
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

Remove unnecessary code comment #666

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Remove unnecessary code comment #666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Improve code comments 
"what" comments add no value. Remove one and make the other describe
"why" the cast is ok.
  • Loading branch information
@tcharding
tcharding committed Nov 14, 2023
commit 458712212d4a2340bf3fcfc419c0636e8c2770fc
4 changes: 1 addition & 3 deletions src/ecdsa/serialized_signature.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,10 +272,8 @@ mod tests {
#[test]
fn iterator_ops_are_homomorphic() {
let mut fake_signature_data = [0; MAX_LEN];
// fill it with numbers 0 - 71
for (i, byte) in fake_signature_data.iter_mut().enumerate() {
// up to MAX_LEN
Copy link
Collaborator

Choose a reason for hiding this comment

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

This was meant as justification why as is OK. :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, I didn't read it as such, my bad. I can re-work this and improve instead of remove the comment.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Both options sound fine to me.

Copy link
Member

Choose a reason for hiding this comment

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

It should be on the same line as the as so that it's visible with grep.

rustfmt might fuck it up; see the most recent rustfmt fight in which inline comments were described as "weird" and "C like". But hopefully not.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Well, that's at least uncommon. And you can give grep context. Although I do think it'd be nice if Rust folks were more welcoming towards people who need to document their code this way. ;)

Copy link
Member Author

Choose a reason for hiding this comment

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

It stays on the line.

*byte = i as u8;
*byte = i as u8; // cast ok because MAX_LEN fits in u8.
}

let fake_signature = SerializedSignature { data: fake_signature_data, len: MAX_LEN };
Expand Down