refactor: typos in doc strings

This commit is contained in:
jstoobysmith 2025-02-12 10:34:58 +00:00
parent ea29b15e4a
commit 73717f151f
3 changed files with 12 additions and 5 deletions

View file

@ -171,6 +171,14 @@ def noLemmas : CoreM Nat := do
let x ← imports.mapM HepLean.Imports.getUserConsts
x.flatFilterSizeM fun c => return !c.isDef && (← c.name.hasPos)
/-- All docstrings present in HepLean. -/
def allDocStrings : CoreM (Array String) := do
let imports ← HepLean.allImports
let x ← imports.mapM HepLean.Imports.getUserConsts
let x' := x.flatten
let docString ← x'.mapM fun c => Lean.Name.getDocString c.name
return docString
/-- Number of definitions without a doc-string. -/
def noDefsNoDocString : CoreM Nat := do
let imports ← HepLean.allImports

View file

@ -71,13 +71,13 @@ variable (𝓕 : FieldSpecification)
/-- For a field specification `𝓕`, the inductive type `𝓕.FieldOp` is defined
to contain the following elements:
- for every `f` in `𝓕.Field`, element of `e` of `AsymptoticLabel f` and `3`-momentum `p`, an
- For every `f` in `𝓕.Field`, element of `e` of `AsymptoticLabel f` and `3`-momentum `p`, an
element labelled `inAsymp f e p` corresponding to an incoming asymptotic field operator
of the field `f`, of label `e` (e.g. specifying the spin), and momentum `p`.
- for every `f` in `𝓕.Field`, element of `e` of `PositionLabel f` and space-time position `x`, an
- For every `f` in `𝓕.Field`, element of `e` of `PositionLabel f` and space-time position `x`, an
element labelled `position f e x` corresponding to a position field operator of the field `f`,
of label `e` (e.g. specifying the Lorentz index), and position `x`.
- for every `f` in `𝓕.Field`, element of `e` of `AsymptoticLabel f` and `3`-momentum `p`, an
- For every `f` in `𝓕.Field`, element of `e` of `AsymptoticLabel f` and `3`-momentum `p`, an
element labelled `outAsymp f e p` corresponding to an outgoing asymptotic field operator of the
field `f`, of label `e` (e.g. specifying the spin), and momentum `p`.
@ -94,7 +94,6 @@ As some intuition, if `f` corresponds to a Weyl-fermion field, then
once represented in the operator algebra, be proportional to the
annihilation operator `a†(p, s)`.
This type contains all operators which are related to a field.
-/
inductive FieldOp (𝓕 : FieldSpecification) where
| inAsymp : (Σ f, 𝓕.AsymptoticLabel f) × (Fin 3 → ) → 𝓕.FieldOp

View file

@ -16,7 +16,7 @@ variable {𝓕 : FieldSpecification}
/--
Given a natural number `n`, which will correspond to the number of fields needing
contracting, a Wick contraction
is a finite set of pairs of `Fin n` (numbers `0`, , `n-1`), such that no
is a finite set of pairs of `Fin n` (numbers `0`, ..., `n-1`), such that no
element of `Fin n` occurs in more then one pair. The pairs are the positions of fields we
'contract' together.
-/