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

Add examples and comments for all tactics that don't have them yet #86

Open
awalterschulze opened this issue May 30, 2020 · 0 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@awalterschulze
Copy link
Member

The contributing guidelines has a new preference:

Tactics unlike proofs, definitions, etc. don't have any types. This means they lack some documentation and type checking. For this reason, we prefer that new tactics come with:
  - some comments above that describe the tactic.
  - some examples below that use the tactic.

https://github.com/awalterschulze/regex-reexamined-coq/blob/master/CONTRIBUTING.md#tactics

There is still lots of tactics that have been committed that don't have examples or comments from before this new preference.

Search the codebase for Ltac and find these occurrences, add examples and comments as described. Here is an example of how to add examples and comments.
https://github.com/awalterschulze/regex-reexamined-coq/blob/master/src/CoqStock/WreckIt.v

@awalterschulze awalterschulze added the good first issue Good for newcomers label May 30, 2020
@awalterschulze awalterschulze added the documentation Improvements or additions to documentation label Aug 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant