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.

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

Meaningless usage of comment decorators #62601

Closed
tcharding opened this issue Jul 11, 2019 · 3 comments
Closed

Meaningless usage of comment decorators #62601

tcharding opened this issue Jul 11, 2019 · 3 comments
Assignees
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@tcharding
Copy link

tcharding commented Jul 11, 2019

We have a number of places in the code base that use 'comment decorators' i.e. from rustlib/src/rust/src/libcore/option.rs

/////////////////////////////////////////////////////////////////////////////
// Type implementation
/////////////////////////////////////////////////////////////////////////////

impl<T> Option<T> {

This adds no extra meaning to the code and is totally specific to the developer that wrote it. We should remove this sort of thing :)

[path/to/rustlib/src/rust/src/libcore/] $ egrep -R '/////////////////////' | wc -l
74

This issue has been assigned to @sd234678 via this comment.

@Centril Centril added C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jul 11, 2019
@Mark-Simulacrum Mark-Simulacrum added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Aug 5, 2019
@sd234678
Copy link
Contributor

sd234678 commented Aug 7, 2019

@rustbot claim

@sd234678
Copy link
Contributor

sd234678 commented Sep 5, 2019

I think this might want closing as well now, @nikomatsakis?

@nikomatsakis
Copy link
Contributor

Sounds good, thanks! Closing per this conversation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants