doc: Add module docstrings and info about ~q()
#47
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
YaelDillies
reviewed
Jul 17, 2024
Comment on lines
+45
to
+48
| let ⟨1, ~q(Nat), ~q($n + 37)⟩ ← inferTypeQ e | return none | ||
| return some n | ||
| ``` | ||
| This is performing three sequential matches: first that `e` is in `Sort 1`, |
There was a problem hiding this comment.
I am very sure this should be
Suggested change
| let ⟨1, ~q(Nat), ~q($n + 37)⟩ ← inferTypeQ e | return none | |
| return some n | |
| ``` | |
| This is performing three sequential matches: first that `e` is in `Sort 1`, | |
| let ⟨0, ~q(Nat), ~q($n + 37)⟩ ← inferTypeQ e | return none | |
| return some n | |
| ``` | |
| This is performing three sequential matches: first that `e` is in `Type 0`, |
There was a problem hiding this comment.
That example is different, there you have α : Q(Type u), but the return type of inferTypeQ is Q(Sort u).
No, but I figured docstrings somewhere now was better than a plan much later. |
|
Then this looks good to me, but I don't have merge rights |
|
@dwrensha, could you take a quick look too? I seem to remember you writing some Qq code in the past. If it looks good to you, I'll go ahead and merge. |
|
Looks good to me. Thanks for doing this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm sure much more could be written here, but this makes common patterns in mathlib a little more understandable from the vscode hovers alone.