chore: fix some docstrings (#6410)

Minor: Uniformize language. Fix some typos.
This commit is contained in:
François G. Dorais 2024-12-18 14:32:07 -05:00 committed by GitHub
parent 1214e6463f
commit 75fc103be4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2116,16 +2116,14 @@ instance : Commutative Or := ⟨fun _ _ => propext or_comm⟩
instance : Commutative And := ⟨fun _ _ => propext and_comm⟩
instance : Commutative Iff := ⟨fun _ _ => propext iff_comm⟩
/-- `IsRefl X r` means the binary relation `r` on `X` is reflexive. -/
/-- `Refl r` means the binary relation `r` is reflexive, that is, `r x x` always holds. -/
class Refl (r : αα → Prop) : Prop where
/-- A reflexive relation satisfies `r a a`. -/
refl : ∀ a, r a a
/--
`Antisymm (·≤·)` says that `(·≤·)` is antisymmetric, that is, `a ≤ b → b ≤ a → a = b`.
-/
/-- `Antisymm r` says that `r` is antisymmetric, that is, `r a b → r b a → a = b`. -/
class Antisymm (r : αα → Prop) : Prop where
/-- An antisymmetric relation `(·≤·)` satisfies `a ≤ b → b ≤ a → a = b`. -/
/-- An antisymmetric relation `r` satisfies `r a b → r b a → a = b`. -/
antisymm (a b : α) : r a b → r b a → a = b
@[deprecated Antisymm (since := "2024-10-16"), inherit_doc Antisymm]
@ -2143,8 +2141,8 @@ class Total (r : αα → Prop) : Prop where
/-- A total relation satisfies `r a b r b a`. -/
total : ∀ a b, r a b r b a
/-- `Irrefl X r` means the binary relation `r` on `X` is irreflexive (that is, `r x x` never
holds). -/
/-- `Irrefl r` means the binary relation `r` is irreflexive, that is, `r x x` never
holds. -/
class Irrefl (r : αα → Prop) : Prop where
/-- An irreflexive relation satisfies `¬ r a a`. -/
irrefl : ∀ a, ¬r a a