Skip to content

Commit baa2f7f

Browse files
committed
chore(*): fix a few docstring syntax errors
This PR goes through the first few errors in the docstring Verso linter that haven't been silenced by leanprover-community#37588 and fixes the issues that got flagged. It is not a systematic cleanup, just things spotted while I was debugging the linter.
1 parent 551ca8f commit baa2f7f

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

Mathlib/Data/List/Indexes.lean

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module
88
public import Mathlib.Data.List.Defs
99

1010
/-!
11-
# Lemmas about List.*Idx functions.
11+
# Lemmas about `List.*Idx` functions.
1212
1313
Some specification lemmas for `List.mapIdx`, `List.mapIdxM`, `List.foldlIdx` and `List.foldrIdx`.
1414

Mathlib/Tactic/Linarith/Oracle/SimplexAlgorithm/SimplexAlgorithm.lean

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ def chooseExitingVar (enterIdx : Nat) : SimplexAlgorithmM matType Nat := do
107107

108108
/--
109109
Chooses entering and exiting variables using
110-
(Bland's rule)[(https://en.wikipedia.org/wiki/Bland%27s_rule)] that guarantees that the Simplex
110+
[Bland's rule](https://en.wikipedia.org/wiki/Bland%27s_rule) that guarantees that the Simplex
111111
Algorithm terminates.
112112
-/
113113
def choosePivots : SimplexAlgorithmM matType (Nat × Nat) := do

Mathlib/Tactic/Relation/Rfl.lean

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public meta import Lean.Meta.Tactic.Rfl
1212
# `Lean.MVarId.liftReflToEq`
1313
1414
Convert a goal of the form `x ~ y` into the form `x = y`, where `~` is a reflexive
15-
relation, that is, a relation which has a reflexive lemma tagged with the attribute `[refl]`.
15+
relation, that is, a relation which has a reflexive lemma tagged with the attribute `@[refl]`.
1616
If this can't be done, returns the original `MVarId`.
1717
-/
1818

@@ -24,7 +24,7 @@ open Lean Meta Elab Tactic Rfl
2424

2525
/--
2626
This tactic applies to a goal whose target has the form `x ~ x`, where `~` is a reflexive
27-
relation, that is, a relation which has a reflexive lemma tagged with the attribute [refl].
27+
relation, that is, a relation which has a reflexive lemma tagged with the attribute `@[refl]`.
2828
-/
2929
def rflTac : TacticM Unit :=
3030
withMainContext do liftMetaFinishingTactic (·.applyRfl)

Mathlib/Tactic/Translate/Core.lean

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ register_option linter.translateReorder : Bool := {
146146
descr := "Linter used by translate attributes that checks if the given reorder is \
147147
equal to the automatically generated one" }
148148

149-
/-- Linter used by translate attributes that checks if the relevant_arg is
149+
/-- Linter used by translate attributes that checks if the `relevant_arg` is
150150
automatically generated. -/
151151
register_option linter.translateRelevantArg : Bool := {
152152
defValue := true

Mathlib/Tactic/Widget/Conv.lean

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ public def Path.ofSubExprPos (expr : Expr) (pos : SubExpr.Pos) : MetaM Path :=
166166

167167
open Lean.Parser.Tactic.Conv in
168168
/--
169-
Given a `path : Path` and `xs : TSepArray ``enterArg ","`, generate the `conv` syntax
169+
Given a `path : Path` and ```xs : TSepArray ``enterArg ","```, generate the `conv` syntax
170170
corresponding to `enter [xs,*]` followed by traversing `path`. If `loc` is `some fvar`,
171171
start with `conv at fvar =>`, otherwise if `loc` is `none` start with `conv =>`.
172172
-/

Mathlib/Util/Tactic.lean

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ public meta import Lean.MetavarContext
1111
/-!
1212
# Miscellaneous helper functions for tactics.
1313
14-
[TODO] Ideally we would find good homes for everything in this file, eventually removing it.
14+
TODO: Ideally we would find good homes for everything in this file, eventually removing it.
1515
-/
1616

1717
public meta section

0 commit comments

Comments
 (0)