Skip to content

Commit

Permalink
(tactic/tidy): add docstring [skip ci] (#1788)
Browse files Browse the repository at this point in the history
* (tactic/tidy): add docstring [skip ci]

* Update src/tactic/tidy.lean

* mention [tidy] attribute
  • Loading branch information
kbuzzard authored and mergify[bot] committed Dec 7, 2019
1 parent 3c9f8f0 commit 4c382b1
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/tactic/tidy.lean
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ meta def tidy (cfg : tidy.cfg := {}) := tactic.tidy.core cfg >> skip
namespace interactive
open lean.parser interactive

/-- Use a variety of conservative tactics to solve goals.
`tidy?` reports back the tactic script it found.
The default list of tactics is stored in `tactic.tidy.default_tidy_tactics`.
This list can be overridden using `tidy { tactics := ... }`.
(The list must be a `list` of `tactic string`, so that `tidy?`
can report a usable tactic script.)
Tactics can also be added to the list by tagging them (locally) with the
`[tidy]` attribute. -/
meta def tidy (trace : parse $ optional (tk "?")) (cfg : tidy.cfg := {}) :=
tactic.tidy { trace_result := trace.is_some, ..cfg }
end interactive
Expand Down

0 comments on commit 4c382b1

Please sign in to comment.