Skip to content

Add invalid doc comment help message - #36964

Merged
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:comment_error
Oct 19, 2016
Merged

Add invalid doc comment help message#36964
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:comment_error

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Oct 4, 2016

Copy link
Copy Markdown
Member

Fixes#36946.

Any opinion on the message?

@rust-highfive

rust-highfive commented Oct 4, 2016

Copy link
Copy Markdown
Contributor

r? @pnkfelix

(rust_highfive has picked a reviewer for you, use r? to override)

solson
solson reviewed Oct 4, 2016
View reviewed changes
Comment threadsrc/libsyntax/feature_gate.rs Outdated

@solsonsolsonOct 4, 2016•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would instead make a version of this function (say, feature_err) that returns the err instead of calling err.emit(), and have this function just do feature_err(...).emit(). Then the existing callers of this function don't need to change for the None argument, and the stmt_expr_attributes one can do let err = feature_err(...); err.help(...); err.emit();.

Comment threadsrc/libsyntax/config.rs Outdated

@solsonsolsonOct 4, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would say something like

`///` is for documentation comments. For a plain comment, use `//`.

@solsonsolsonOct 4, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Won't this help trigger for all misplaced attributes? It should only trigger for misplaced doc attributes.

@bors

bors commented Oct 7, 2016

Copy link
Copy Markdown
Collaborator

☔ The latest upstream changes (presumably #36945) made this pull request unmergeable. Please resolve the merge conflicts.

@GuillaumeGomez

GuillaumeGomez commented Oct 8, 2016

Copy link
Copy Markdown
MemberAuthor

Updated.

solson
solson approved these changes Oct 8, 2016
View reviewed changes

@solsonsolson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me!

@GuillaumeGomez

GuillaumeGomez commented Oct 9, 2016

Copy link
Copy Markdown
MemberAuthor

We now need a reviewer. cc @jonathandturner :p

solson
solson suggested changes Oct 9, 2016
View reviewed changes
Comment threadsrc/libsyntax/config.rs Outdated

@solsonsolsonOct 9, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh, I forgot to bring this up again.

This help should only be generated for misplaced doc comments, but this will generate it for any misplaced attributes at all.

@sophiajtsophiajtOct 11, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@solson - sounds like an interesting point. @GuillaumeGomez ?

@GuillaumeGomezGuillaumeGomezOct 12, 2016

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Didn't think of testing in other cases. Good point! I'll check a bit later.

frewsxcv
frewsxcv reviewed Oct 11, 2016
View reviewed changes
Comment threadsrc/libsyntax/feature_gate.rs Outdated

@frewsxcvfrewsxcvOct 11, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: indentation is off here

@GuillaumeGomez

GuillaumeGomez commented Oct 18, 2016

Copy link
Copy Markdown
MemberAuthor

Updated.

@sophiajt

sophiajt commented Oct 18, 2016

Copy link
Copy Markdown
Contributor

@bors r+ rollup

@bors

bors commented Oct 18, 2016

Copy link
Copy Markdown
Collaborator

📌 Commit 93417fa has been approved by jonathandturner

@eddybeddyb mentioned this pull request Oct 18, 2016
Closed
eddyb added a commit to eddyb/rust that referenced this pull request Oct 19, 2016
@eddyb
Rollup merge ofrust-lang#36964- GuillaumeGomez:comment_error, r=jon…
c98211d
…athandturner
Add invalid doc comment help message
Fixesrust-lang#36946.
Any opinion on the message?
eddyb added a commit to eddyb/rust that referenced this pull request Oct 19, 2016
@eddyb
Rollup merge ofrust-lang#36964- GuillaumeGomez:comment_error, r=jon…
fdcdcac
…athandturner
Add invalid doc comment help message
Fixesrust-lang#36946.
Any opinion on the message?
@eddybeddyb mentioned this pull request Oct 19, 2016
Merged
bors added a commit that referenced this pull request Oct 19, 2016
@bors
Auto merge of#37269- eddyb:rollup, r=eddyb
0c42987
Rollup of 23 pull requests
- Successful merges: #36964, #37108, #37117, #37124, #37161, #37176, #37182, #37193, #37198, #37202, #37208, #37218, #37221, #37224, #37230, #37231, #37233, #37236, #37240, #37254, #37257, #37265, #37267
- Failed merges: #37213, #37220, #37261
@bors
bors merged commit 93417fa into rust-lang:masterOct 19, 2016
@GuillaumeGomez
GuillaumeGomez deleted the comment_error branch October 19, 2016 13:33
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers
@frewsxcvfrewsxcvfrewsxcv left review comments
@sophiajtsophiajtsophiajt left review comments
@solsonsolsonsolson requested changes
Reviewers whose approvals may not affect merge requirements

Assignees

@pnkfelixpnkfelix

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@GuillaumeGomez@rust-highfive@bors@sophiajt@solson@frewsxcv@pnkfelix