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

Improve every text: titles, messages, and descriptions of the analyzers and code-fixes #234

Closed
mikkelbu opened this issue May 6, 2020 · 0 comments · Fixed by #242
Closed
Assignees
Milestone

Comments

@mikkelbu
Copy link
Member

mikkelbu commented May 6, 2020

We should go through all texts: titles, messages, and descriptions of the analyzers and code-fixes and see if the text can be improved.

Extracted from #230

Nitpicking ahead, feel free to take it or leave it:

The message should be more casual and accessible. Right now, it is terse to the point of detracting from its readability. There are no articles (a/an/the) in the sentence. It is a good practice though to look for words to delete in every message without losing meaning or readability. For example, I think that the word 'provided' could be removed in the message above without loss of clarity. Here's a placeholder example: "The SameAs constraint always fails because the actual and expected values have mutually exclusive types."

A comprehensive resource that helps me is https://docs.microsoft.com/en-us/style-guide/top-10-tips-style-voice. I like what they're doing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant