Skip to content

feat(contribute/doc.md): describe tactic doc guidelines #772

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.

Sign up for GitHub

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

Merged
PatrickMassot merged 1 commit into from
Jan 19, 2026
Merged

feat(contribute/doc.md): describe tactic doc guidelines #772

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions templates/contribute/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,19 @@ def padicValRat (p : ℕ) (q : ℚ) : ℤ :=
padicValInt p q.num - padicValNat p q.den
```

### Tactic documentation

Tactics should have a docstring that matches the [Lean documentation style guide](https://github.com/leanprover/lean4/blob/master/doc/style.md#tactics).
Key points are: Be complete and self-contained but brief. The docstring should start with a full
sentence that has the tactic as the subject. (Example: "`rewrite [e]` uses the expression `e` as a
rewrite rule on the main goal.") All different options and forms of the tactic should appear in a
bulleted list. The "Examples:" section, if any, should be a sequence of code blocks.

### Linting

The `docBlame` linter lists all definitions that do not have doc strings. The `docBlameThm`
linter will lists theorems and lemmas that do not have doc strings.
linter will lists theorems and lemmas that do not have doc strings. The `tacticDocs` linter lists
all tactics that do not have docstrings.

To run only the `docBlame` linter, add the following to the end of your lean file:
```
Expand All @@ -121,8 +132,8 @@ file:
```
#lint only docBlame docBlameThm
```
To run the all default linters, including `docBlame`, add the following to the end of your lean
file:
To run the all default linters, including `docBlame` and `tacticDocs`, add the following to the end
of your lean file:
```
#lint
```
Expand Down