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

Normalize diagnostics to use either a backtick or a single quote, not both at random #1160

Open
whitequark opened this issue Feb 27, 2024 · 2 comments

Comments

@whitequark
Copy link
Member

Bikeshed: which of these should we use?

@tpwrules
Copy link
Contributor

What is an example of each in the code as it stands?

I'd say that backticks are better for code examples in like "x is bad. Do y". But single quotes are better for values, like "x should be a y, not 'z'"

@whitequark
Copy link
Member Author

I'd say that backticks are better for code examples in like "x is bad. Do y". But single quotes are better for values, like "x should be a y, not 'z'"

I like this distinction!

What is an example of each in the code as it stands?

Backticks:

raise TypeError("The `convert()` function requires a `ports=` argument")

Single quotes:

raise AttributeError("Platform '{}' does not constrain its default clock"

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

No branches or pull requests

2 participants