refactor: Lint

HepLean/Meta/Basic.lean

@@ -123,6 +123,7 @@ def Name.hasDocString (c : Name) : MetaM Bool := do
   | some _ => pure true
   | none => pure false
 
+/-- The doc string from a name. -/
 def Name.getDocString (c : Name) : MetaM String := do
   let env ← getEnv
   let doc ← Lean.findDocString? env c

HepLean/Meta/Remark/Basic.lean

@@ -37,7 +37,7 @@ initialize remarkExtension : SimplePersistentEnvExtension RemarkInfo (Array Rema
   }
 
 /-- A remark is a string used for important information. -/
-syntax (name := remark_syntax) "remark " ident  ":=" str : command
+syntax (name := remark_syntax) "remark " ident ":=" str : command
 
 /-- Elaborator for the `note ...` command -/
 @[command_elab remark_syntax]

HepLean/Meta/Remark/Properties.lean

@@ -12,17 +12,20 @@ import HepLean.Meta.Remark.Basic
 namespace HepLean
 open Lean System Meta
 
+/-- All remarks in the enviroment. -/
 def Name.allRemarkInfo : MetaM (List RemarkInfo) := do
   let env ← getEnv
   let allRemarks := (remarkExtension.getState env)
   pure allRemarks.toList
 
-def RemarkInfo.toFullName (r : RemarkInfo) :  Name :=
+/-- The full name of a remark (name and namespace). -/
+def RemarkInfo.toFullName (r : RemarkInfo) : Name :=
   if r.nameSpace != .anonymous then
     (r.nameSpace.toString ++ "." ++ r.name.toString).toName
   else
     r.name
 
+/-- A Bool which is true if a name correponds to a remark. -/
 def RemarkInfo.IsRemark (n : Name) : MetaM Bool := do
   let allRemarks ← Name.allRemarkInfo
   let r := allRemarks.find? (fun r => r.toFullName = n)
@@ -30,6 +33,7 @@ def RemarkInfo.IsRemark (n : Name) : MetaM Bool := do
   | some _ => pure true
   | none => pure false
 
+/-- Gets the remarkInfo from a name corresponding to a remark.. -/
 def RemarkInfo.getRemarkInfo (n : Name) : MetaM RemarkInfo := do
   let allRemarks ← Name.allRemarkInfo
   let r := allRemarks.find? (fun r => r.toFullName = n)

HepLean/PerturbationTheory/Algebras/StateAlgebra/TimeOrder.lean

@@ -65,7 +65,8 @@ lemma timeOrder_ofState_ofState_not_ordered_eq_timeOrder {φ ψ : 𝓕.States} (
   have hx := IsTotal.total (r := timeOrderRel) ψ φ
   simp_all
 
-/-- In the state algebra time, ordering obeys `T(φ₀φ₁…φₙ) = s * φᵢ * T(φ₀φ₁…φᵢ₋₁φᵢ₊₁…φₙ)` where `φᵢ` is the state
+/-- In the state algebra time, ordering obeys `T(φ₀φ₁…φₙ) = s * φᵢ * T(φ₀φ₁…φᵢ₋₁φᵢ₊₁…φₙ)`
+  where `φᵢ` is the state
   which has maximum time and `s` is the exchange sign of `φᵢ` and `φ₀φ₁…φᵢ₋₁`. -/
 lemma timeOrder_eq_maxTimeField_mul (φ : 𝓕.States) (φs : List 𝓕.States) :
     timeOrder (ofList (φ :: φs)) =
@@ -78,7 +79,8 @@ lemma timeOrder_eq_maxTimeField_mul (φ : 𝓕.States) (φs : List 𝓕.States)
   rw [timerOrderSign_of_eraseMaxTimeField, mul_assoc]
   simp
 
-/-- In the state algebra time, ordering obeys `T(φ₀φ₁…φₙ) = s * φᵢ * T(φ₀φ₁…φᵢ₋₁φᵢ₊₁…φₙ)` where `φᵢ` is the state
+/-- In the state algebra time, ordering obeys `T(φ₀φ₁…φₙ) = s * φᵢ * T(φ₀φ₁…φᵢ₋₁φᵢ₊₁…φₙ)`
+  where `φᵢ` is the state
   which has maximum time and `s` is the exchange sign of `φᵢ` and `φ₀φ₁…φᵢ₋₁`.
   Here `s` is written using finite sets. -/
 lemma timeOrder_eq_maxTimeField_mul_finset (φ : 𝓕.States) (φs : List 𝓕.States) :

HepLean/PerturbationTheory/WicksTheorem.lean

@@ -27,7 +27,7 @@ open FieldStatistic
 
 /--
 Let `c` be a Wick Contraction for `φ₀φ₁…φₙ`.
-We have  (roughly) `N(c.insertList φ φs i none).uncontractedList = s • N(φ * c.uncontractedList)`
+We have (roughly) `N(c.insertList φ φs i none).uncontractedList = s • N(φ * c.uncontractedList)`
 Where `s` is the exchange sign for `φ` and the uncontracted fields in `φ₀φ₁…φᵢ`.
 -/
 lemma insertList_none_normalOrder (φ : 𝓕.States) (φs : List 𝓕.States)
@@ -324,7 +324,7 @@ remark wicks_theorem_context := "
   for all possible Wick contractions `c` of the list of fields `φs := φ₀φ₁…φₙ`, given by
   the multiple of:
 - The sign corresponding to the number of fermionic-fermionic exchanges one must do
-    to put  elements in contracted pairs of `c` next to each other.
+    to put elements in contracted pairs of `c` next to each other.
 - The product of time-contractions of the contracted pairs of `c`.
 - The normal-ordering of the uncontracted fields in `c`.
 -/