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

Jump to bottom

Do not parse a line with only /s as a doc comment #4887

Closed
lifthrasiir opened this issue Feb 11, 2013 · 0 comments
Closed

Do not parse a line with only /s as a doc comment #4887

lifthrasiir opened this issue Feb 11, 2013 · 0 comments
Labels
A-parser Area: The parsing of Rust source code to an AST E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Milestone
old 1.0 milestone

Comments

@lifthrasiir
Copy link
Contributor

A line filled with only /s is occasionally used as a separator in the code. Rust currently parses it as a doc comment which causes unwanted headaches, as shown below:

////////////////////////////////////////
// common macros

macro_rules! foo( ... ) // error: macro_rules! do not support #[doc = ...]
macro_rules! bar( ... )

While such separators should be avoided in favor of the module system, it is still useful for logically splitting large functions for instance. Also related to #4106.
@lifthrasiir lifthrasiir mentioned this issue Feb 13, 2013
Closed
bors added a commit that referenced this issue Feb 15, 2013
@bors
auto merge of #4911 : lifthrasiir/rust/comment-exemptions, r=catamorp…
bf27352 
…hism

This is a natural extension of #4887, and handles the following three cases:

~~~~
a line with only /s
////////////////////////////////////////////

a line with only /s followed by whitespace
////////////////////////////////////////////         

a block comment with only *s between two /s
/********************************/
~~~~
flip1995 pushed a commit to flip1995/rust that referenced this issue Feb 25, 2021
@bors
Auto merge of rust-lang#6179 - flip1995:rewrite_use_self, r=phansch
605e9ba 
Rework use_self impl based on ty::Ty comparison rust-lang#3410 | Take 2

This builds on top of rust-lang#5531

I already reviewed and approved the commits by `@montrivo.` So only the review of my commits should be necessary.

I would also appreciate your review `@montrivo,` since you are familiar with the challenges here.

Fixes rust-lang#3410 and Fixes rust-lang#4143 (same problem)
Fixes rust-lang#2843
Fixes rust-lang#3859
Fixes rust-lang#4734 and fixes rust-lang#6221
Fixes rust-lang#4305
Fixes rust-lang#5078 (even at expression level now 🎉)
Fixes rust-lang#3881 and Fixes rust-lang#4887 (same problem)
Fixes rust-lang#3909

Not yet: rust-lang#4140 (test added)

All the credit for the fixes goes to `@montrivo.` I only refactored and copy and pasted his code.

changelog: rewrite [`use_self`] lint and fix multiple (8) FPs. One to go.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-parser Area: The parsing of Rust source code to an AST E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
old 1.0 milestone
Development

No branches or pull requests
1 participant
@lifthrasiir