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: syntax documentation for universe, open, export, variable #2645

Merged
merged 36 commits into from
Nov 17, 2023

Conversation

AdrienChampion
Copy link
Contributor

@AdrienChampion AdrienChampion commented Oct 10, 2023

Mentored by @digama0, adds syntax-documentation with examples to universe, open, export, and variable.

The documentation shows up when hovering over keywords, hopefully improving the experience for beginners.

@github-actions github-actions bot added awaiting-review Waiting for someone to review the PR toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN labels Oct 10, 2023
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 10, 2023
@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Oct 10, 2023
@leanprover-community-mathlib4-bot
Copy link
Collaborator

leanprover-community-mathlib4-bot commented Oct 10, 2023

Copy link
Contributor

@david-christiansen david-christiansen left a comment

Choose a reason for hiding this comment

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

This is a great improvement, thanks!

I think it can be even better with some small modifications. They come in a few categories:

  1. Describing not just what the feature does, but also the problems that it solves for users
  2. Using less-abstract examples that are more likely to be understood by our audiences
  3. Reducing the technical programming-languages jargon
  4. Picking syntactic metavariables that have less potential for confusion

Thanks again, and please let me know if there's anything unclear in my comments!

src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 14, 2023
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 19, 2023
Copy link
Contributor

@david-christiansen david-christiansen left a comment

Choose a reason for hiding this comment

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

It looks like you've made great progress on it!

src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 22, 2023
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 23, 2023
Copy link
Contributor

@david-christiansen david-christiansen left a comment

Choose a reason for hiding this comment

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

Almost there! I'm happy to finish this up if you're getting discouraged, but I think there's just a couple minor details and then I'll think we're good to go. Thank you so much for your patience!

src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
src/Lean/Elab/BuiltinCommand.lean Outdated Show resolved Hide resolved
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 24, 2023
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Oct 31, 2023
@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added breaks-mathlib This is not necessarily a blocker for merging: but there needs to be a plan and removed builds-mathlib CI has verified that Mathlib builds against this PR labels Oct 31, 2023
kim-em added a commit to leanprover-community/mathlib4 that referenced this pull request Nov 5, 2023
@kim-em kim-em removed the breaks-mathlib This is not necessarily a blocker for merging: but there needs to be a plan label Nov 6, 2023
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Nov 6, 2023
@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Nov 6, 2023
@david-christiansen david-christiansen enabled auto-merge (squash) November 17, 2023 12:33
@david-christiansen david-christiansen merged commit ed1a98d into leanprover:master Nov 17, 2023
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-review Waiting for someone to review the PR 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.

6 participants