Skip to content

Upgrade a comment to a doc comment #43936

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 2 commits into from
Aug 20, 2017
Merged

Upgrade a comment to a doc comment #43936

merged 2 commits into from
Aug 20, 2017

Conversation

oli-obk
Copy link
Contributor

@oli-obk oli-obk commented Aug 17, 2017

@oli-obk
Copy link
Contributor Author

oli-obk commented Aug 17, 2017

Maybe we should have a lint that forbids comments before undocumented public items and other documentable things.

@bjorn3
Copy link
Member

bjorn3 commented Aug 17, 2017

Forgot to submit one more review comment.

@bjorn3
Copy link
Member

bjorn3 commented Aug 17, 2017

Maybe we should have a lint that forbids comments before undocumented public items and other documentable things.

It should also detect enum variant followed by comment on the same line. I have seen quite a lot in older code.

@oli-obk
Copy link
Contributor Author

oli-obk commented Aug 17, 2017

Maybe this is something rustfmt could do?

@alexcrichton
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 17, 2017

📌 Commit 9346fe9 has been approved by alexcrichton

aidanhs added a commit to aidanhs/rust that referenced this pull request Aug 18, 2017
@aidanhs
Rollup merge of rust-lang#43936 - oli-obk:patch-6, r=alexcrichton
1079de0 
Upgrade a comment to a doc comment

r? @alexcrichton

cc @bjorn3
@aidanhs aidanhs mentioned this pull request Aug 18, 2017
Closed
bors added a commit that referenced this pull request Aug 18, 2017
@bors
Auto merge of #43980 - aidanhs:rollup, r=aidanhs
2433156 
Rollup of 4 pull requests

- Successful merges: #43919, #43936, #43950, #43978
- Failed merges:
@bors
Copy link
Collaborator

bors commented Aug 19, 2017

⌛ Testing commit 9346fe9 with merge c84b2f43587b0ae3170d2ba68b5f88dcce5fc644...

@bors
Copy link
Collaborator

bors commented Aug 19, 2017

💔 Test failed - status-appveyor

@kennytm
Copy link
Member

kennytm commented Aug 19, 2017

@bors retry #43985

@bjorn3
Copy link
Member

bjorn3 commented Aug 19, 2017

Was working on some more comment to doc comment changes, but got tired as I already have ~500 changes and I have about 100 to go according to my code 😢

https://github.com/bjorn3/rust/tree/tidy_comment_check

@bors
Copy link
Collaborator

bors commented Aug 19, 2017

⌛ Testing commit 9346fe9 with merge b07e730...

bors added a commit that referenced this pull request Aug 19, 2017
@bors
Auto merge of #43936 - oli-obk:patch-6, r=alexcrichton
b07e730 
Upgrade a comment to a doc comment

r? @alexcrichton

cc @bjorn3
@bors
Copy link
Collaborator

bors commented Aug 20, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing b07e730 to master...

@bors bors merged commit 9346fe9 into rust-lang:master Aug 20, 2017
@oli-obk oli-obk deleted the patch-6 branch June 15, 2020 15:26
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@bjorn3 bjorn3 bjorn3 approved these changes

Assignees

@alexcrichton alexcrichton

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@oli-obk @bjorn3 @alexcrichton @bors @kennytm