6 Commits

Author SHA1 Message Date
Anne Baanen
0f866236c7 doc: write a guideline for tactic docstrings (#11406)
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>
2026-01-06 04:40:20 +00:00
David Thrane Christiansen
7f4f6b3457 doc: add documentation style guide (#8199)
This PR adds a style guide for documentation, including both general
principles and docstring-specific concerns.
2025-05-02 13:05:18 +00:00
Soonho Kong
70e7bcd9e4 doc(coding_style): rename style.md to coding_style.md 2013-09-25 19:45:15 -07:00
Soonho Kong
4a66712ef2 doc(style): update C++ style guide 2013-09-25 17:44:27 -07:00
Soonho Kong
f752d4c791 Update style.md 2013-09-13 20:30:48 -07:00
Leonardo de Moura
9031c42df2 Add coding style and notes
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
2013-09-13 14:57:17 -07:00