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

Enforce error message style #26

Open
sindresorhus opened this issue May 16, 2016 · 8 comments
Open

Enforce error message style #26

sindresorhus opened this issue May 16, 2016 · 8 comments

Comments

@sindresorhus
Copy link
Owner

avajs/ava#835 (comment)

I want to say: This is a failure, you should use a blimp

Which of the following should it be:

  • This is a failure, you should use a blimp
  • This is a failure. You should use a blimp
  • This is a failure. You should use a blimp.

Keep in mind that if we go for the last one, which looks the best, it becomes inconsistent with one sentence error messages, which usually don't end in a dot.

@kevva
Copy link

kevva commented May 16, 2016

#1 for one sentence error message and #3 for multiple sentences. I don't mind them being inconsistent tbh and it's usually what I do anyway.

@sindresorhus
Copy link
Owner Author

@jfmengels @jamestalmage @SamVerschueren Thoughts?

@SamVerschueren
Copy link
Contributor

Think I like 1 the most.

@sindresorhus
Copy link
Owner Author

@SamVerschueren It's a bad example though. What if you have 3 sentences and comma isn't valid to separate them.

@jfmengels
Copy link
Contributor

Not a big fan of this rule. I understand the frustration, but this will be hard to treat well, and will only work well when writing errors in English. Sounds to me like a rule that will be disabled more often than the others.

@SamVerschueren
Copy link
Contributor

It becomes inconsistent with one sentence error messages, which usually don't end in a dot.

Just wondering why this actually is the case? Why can't we just end all the messages with a dot?

@sindresorhus
Copy link
Owner Author

@SamVerschueren It's common convention to not end error messages in a dot, but it becomes weird when you have multiple sentences.

@sindresorhus
Copy link
Owner Author

@jfmengels Why will it be hard? And why do you think it will only work for English? It will work for any language that ends sentences with a ..

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

No branches or pull requests

4 participants