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

Provide an optional comment box along with rules #80

Open
NicMcPhee opened this issue May 31, 2019 · 0 comments
Open

Provide an optional comment box along with rules #80

NicMcPhee opened this issue May 31, 2019 · 0 comments

Comments

@NicMcPhee
Copy link
Member

At the moment all we allow is the rule (two expressions and their relationship). There are times when, for readability, the writer might wish to include some additional information, e.g.,

  • A substitution that helps the reader understand how the rule is being used
  • Something like "twice" to indicate that a rule is being multiple times
  • Something like "backwards" to indicate that a rule is being used in what might be the "opposite" way of how we typically use it (although that kind of usage probably isn't supported at the moment by the checker)
  • Any other comment that might help, like "as proved in the preceding lemma"

This would definitely affect the Markdown output if/when we implement #69.

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

No branches or pull requests

1 participant