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

chore: use ' instead of brackets for quotes #4464

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JovanGerb
Copy link
Contributor

Bracket used for quoting an expression, such as (C ...) in

invalid {...} notation, {kind} type is not of the form (C ...){indentExpr type}

have been replaced by 'C ...'. This makes the messages clearer.

@github-actions github-actions bot added the toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN label Jun 16, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Jun 16, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Jun 16, 2024
Copy link
Contributor

@nomeata nomeata left a comment

Choose a reason for hiding this comment

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

It's good to be consistent, but probably subjective which variant is clearer. I'd be curious what @david-christiansen will say.

Also, do we maybe use back ticks in some places as well?

@JovanGerb
Copy link
Contributor Author

Yeah, I wasn't sure about backticks vs single quotes. I went for normal quotes because they seem to be used more than backticks. I don't know of any difference in the meaning between the two.

@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Jun 16, 2024
@leanprover-community-mathlib4-bot
Copy link
Collaborator

Mathlib CI status (docs):

@JovanGerb
Copy link
Contributor Author

Here both quotes are even used in the same error:

throw s!"unexpected type at '{const}', `{type}` expected"

@nomeata
Copy link
Contributor

nomeata commented Jun 16, 2024

My impression, from looking at the lines of code in the diffs, is that single ticks are used to refer to a names and parentheses or backticks to quote expressions. Such semantic differentiation might actually be intended and useful, but then should be documented for the other developers so that we can apply them consistently.

@leodemoura
Copy link
Member

leodemoura commented Jun 17, 2024

It's good to be consistent, but probably subjective which variant is clearer. I'd be curious what @david-christiansen will say.

Also, do we maybe use back ticks in some places as well?

Me too. I feel like we are not using quotes and backticks consistently in error messages and doc-strings. I am also curious about what @david-christiansen will say. We should document the decision, and start enforcing from now on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builds-mathlib CI has verified that Mathlib builds against this PR toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants