8000 Put rustdocs above attributes by tcharding · Pull Request #753 · rust-bitcoin/rust-bitcoin · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Put rustdocs above attributes #753

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

Jump to bottom
Merged
merged 1 commit into from
Jan 6, 2022
Merged

Put rustdocs above attributes #753

merged 1 commit into from
Jan 6, 2022

Conversation

tcharding
Copy link
Member
@tcharding tcharding commented Jan 6, 2022 •
edited
Loading

(Trivial / Very low priority PR)

Rust idiomatic style is to put the rustdoc above any attributes on types, functions, etc.

Audit the codebase and move comments/attributes to the correct place. Add a trailing full stop at times to neaten things up a little extra.

Done after discussion here

@tcharding
Put rustdocs above attributes
5331208 
Rust idiomatic style is to put the rustdoc _above_ any attributes on
types, functions, etc.

Audit the codebase and move comments/attributes to the correct place.
Add a trailing full stop at times to neaten things up a little extra.
@tcharding tcharding mentioned this pull request Jan 6, 2022
Merged
Kixunil
Kixunil approved these changes Jan 6, 2022
View reviewed changes
Copy link
Collaborator
@Kixunil Kixunil left a comment

Choose a reason for hiding this comment

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

ACK 5331208

@Kixunil Kixunil added code quality Makes code easier to understand and less likely to lead to problems documentation one ack PRs that have one ACK, so one more can progress them P-low Low priority trivial Obvious, easy and quick to review (few lines or doc-only...) labels Jan 6, 2022
RCasatta
RCasatta approved these changes Jan 6, 2022
View reviewed changes
Copy link
Collaborator
@RCasatta RCasatta left a comment

Choose a reason for hiding this comment

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

ACK 5331208

@RCasatta RCasatta merged commit 9e7bb09 into rust-bitcoin:master Jan 6, 2022
@dr-orlovsky dr-orlovsky mentioned this pull request Jan 15, 2022
Closed
@tcharding tcharding deleted the comments-attributes branch August 17, 2023 02:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kixunil Kixunil Kixunil approved these changes

@RCasatta RCasatta RCasatta approved these changes

Assignees
No one assigned
Labels
code quality Makes code easier to understand and less likely to lead to problems one ack PRs that have one ACK, so one more can progress them P-low Low priority trivial Obvious, easy and quick to review (few lines or doc-only...)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tcharding @Kixunil @RCasatta
0