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

Audit diagnostic messages for missing quotes around symbol names #1714

Open
mavasani opened this issue Jun 6, 2018 · 6 comments
Open

Audit diagnostic messages for missing quotes around symbol names #1714

mavasani opened this issue Jun 6, 2018 · 6 comments
Labels
Bug The product is not behaving according to its current intended design help wanted The issue is up-for-grabs, and can be claimed by commenting
Milestone
Unknown

Comments

@mavasani
Copy link
Contributor

mavasani commented Jun 6, 2018

I think quite a few of our diagnostic messages were created by an automated tool that ported messages from old FxCop implementation. For example, see #1713 (comment).
@mavasani mavasani added the Bug The product is not behaving according to its current intended design label Jun 6, 2018
@mavasani mavasani added this to the 15.8 milestone Jun 6, 2018
@mavasani mavasani self-assigned this Jun 6, 2018
@mavasani mavasani removed this from the 15.8 milestone Jul 1, 2019
@mavasani mavasani removed their assignment Jul 1, 2019
@sharwell sharwell added help wanted The issue is up-for-grabs, and can be claimed by commenting and removed Up for Grabs labels Aug 1, 2019
@Evangelink
Copy link
Member

@mavasani Do you have some guidelines around when the "thing" should be single quoted? Is it like every time this is a keyword or a type/method/property/... name?

@Evangelink
Copy link
Member

ping @mavasani

@mavasani
Copy link
Contributor Author

mavasani commented Jan 8, 2020

Yes - I think at the very least all symbol names in messages should be within single quotes for clarity.

@Evangelink Evangelink mentioned this issue Jan 9, 2020
Closed
@Evangelink
Copy link
Member

To sum-up some of the exchanges on the 1st draft PR:

  • Prefer SomeAttribute for diagnostics, and [Some] for code fixes.

  • Prefer no '.' for single-sentence titles and messages (and avoid multi-sentence unless it substantially detracts from clarity)

  • Use full sentences with '.' for descriptions

  • Do not use pascal case for all words

@mavasani mavasani mentioned this issue Mar 13, 2020
Merged
@Evangelink
Copy link
Member

Relates to #3525

@mavasani mavasani added this to the Unknown milestone Oct 22, 2020
@Youssef1313
Copy link
Member

I'm removing unused resources in #6341, which should hopefully make this issue easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug The product is not behaving according to its current intended design help wanted The issue is up-for-grabs, and can be claimed by commenting
Projects
None yet
Milestone
Unknown
Development

Successfully merging a pull request may close this issue.

Review diagnostic messages for missing single quotes around symbol names Evangelink/roslyn-analyzers
4 participants
@sharwell @mavasani @Evangelink @Youssef1313