0f866236c7
This PR covers tactic docstrings in the documentation style guide. At the Mathlib Initiative we want to ensure that tactics have good documentation. Since this will involve adding documentation to tactics built into core Lean, I discussed with David that we should write a shared set of documentation guidelines that allow me to do my work both on the Lean and on the Mathlib repositories. I have already shown an earlier version of this guideline to David who made some helpful suggestions but would be away for a few days. So to make sure the discussion doesn't get lost, I've made a PR with the version I ended up with after the first round of comments. --------- Co-authored-by: Robert J. Simmons <442315+robsimmons@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| dev | ||
| examples | ||
| images | ||
| latex | ||
| make | ||
| std | ||
| .gitignore | ||
| BoolExpr.lean | ||
| metaprogramming-arith.lean | ||
| perf.md | ||
| README.md | ||
| style.md | ||
| syntax_example.lean | ||
Developer Documentation and Examples
This directory contains documentation that describes how to work on
Lean itself, as well as examples that are included in documentation
that's hosted on the Lean website. The make directory contains
information on building Lean, and the dev directory describes how to
work on Lean.
The documentation section has links to documentation that describes how to use Lean itself.