Skip to content

Commit 0e15a88

Browse files
committed
doc(CategoryTheory/Bicategory/NaturalTransformation): tidy docstrings (leanprover-community#35274)
1 parent 40724a2 commit 0e15a88

3 files changed

Lines changed: 30 additions & 30 deletions

File tree

Mathlib/CategoryTheory/Bicategory/NaturalTransformation/Lax.lean

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Just as there are natural transformations between functors, there are transforma
1515
between lax functors. The equality in the naturality condition of a natural transformation gets
1616
replaced by a specified 2-morphism. Now, there are three possible types of transformations (between
1717
lax functors):
18-
* Lax natural transformations;
19-
* OpLax natural transformations;
20-
* Strong natural transformations.
18+
* lax natural transformations;
19+
* oplax natural transformations;
20+
* strong natural transformations.
2121
These differ in the direction (and invertibility) of the 2-morphisms involved in the naturality
2222
condition.
2323
@@ -29,19 +29,19 @@ condition.
2929
* `Lax.OplaxTrans F G`: oplax transformations between lax functors `F` and `G`. The naturality
3030
condition is given by a 2-morphism `F.map f ≫ app b ⟶ app a ≫ G.map f` for each 1-morphism
3131
`f : a ⟶ b`.
32-
* `Lax.StrongTrans F G`: Strong transformations between lax functors `F` and `G`. The naturality
33-
condition is given by a 2-morphism `app a ≫ G.map f ≅ F.map f ≫ app b` for each 1-morphism
32+
* `Lax.StrongTrans F G`: strong transformations between lax functors `F` and `G`. The naturality
33+
condition is given by a 2-isomorphism `app a ≫ G.map f ≅ F.map f ≫ app b` for each 1-morphism
3434
`f : a ⟶ b`.
3535
36-
Using these, we define three `CategoryStruct` (scoped) instances on `B ⥤ᴸ C`, in the
37-
`Lax.LaxTrans`, `Lax.Oplax`, and `Lax.StrongTrans` namespaces. The arrows in these
38-
CategoryStruct's are given by lax transformations, oplax transformations, and strong
36+
Using these, we define three (scoped) `CategoryStruct` instances on `B ⥤ᴸ C`, in the
37+
`Lax.LaxTrans`, `Lax.OplaxTrans`, and `Lax.StrongTrans` namespaces. The arrows in these
38+
`CategoryStruct` instances are given by lax transformations, oplax transformations, and strong
3939
transformations respectively.
4040
4141
We also provide API for going between lax transformations and strong transformations:
42-
* `Lax.StrongCore F G`: a structure on a lax transformation between lax functors that
43-
promotes it to a strong transformation.
44-
* `Lax.mkOfLax η η'`: given a lax transformation `η` such that each component
42+
* `LaxTrans.StrongCore η`: a structure on a lax transformation between lax functors that
43+
promotes it to a strong transformation.
44+
* `StrongTrans.mkOfLax η η'`: given a lax transformation `η` such that each component
4545
2-morphism is an isomorphism, `mkOfLax` gives the corresponding strong transformation.
4646
4747
## References
@@ -189,7 +189,7 @@ end LaxTrans
189189
/-- If `η` is an oplax transformation between `F` and `G`, we have a 1-morphism
190190
`η.app a : F.obj a ⟶ G.obj a` for each object `a : B`. We also have a 2-morphism
191191
`η.naturality f : F.map f ≫ app b ⟶ app a ≫ G.map f` for each 1-morphism `f : a ⟶ b`.
192-
These 2-morphisms satisfies the naturality condition, and preserve the identities and
192+
These 2-morphisms satisfy the naturality condition, and preserve the identities and
193193
the compositions modulo some adjustments of domains and codomains of 2-morphisms.
194194
-/
195195
structure OplaxTrans (F G : B ⥤ᴸ C) where
@@ -313,7 +313,7 @@ that is "natural up to 2-isomorphisms".
313313
More precisely, it consists of the following:
314314
* a 1-morphism `η.app a : F.obj a ⟶ G.obj a` for each object `a : B`.
315315
* a 2-isomorphism `η.naturality f : app a ≫ G.map f ≅ F.map f ≫ app b` for each 1-morphism
316-
`f : a ⟶ b`.
316+
`f : a ⟶ b`.
317317
* These 2-isomorphisms satisfy the naturality condition, and preserve the identities and the
318318
compositions modulo some adjustments of domains and codomains of 2-morphisms.
319319
-/
@@ -343,7 +343,7 @@ attribute [reassoc (attr := simp)] StrongTrans.naturality_naturality
343343

344344
/-- A structure on a lax transformation that promotes it to a strong transformation.
345345
346-
See `Pseudofunctor.StrongTrans.mkOfLax`. -/
346+
See `StrongTrans.mkOfLax`. -/
347347
structure LaxTrans.StrongCore {F G : B ⥤ᴸ C} (η : F ⟶ G) where
348348
/-- The underlying 2-isomorphisms of the naturality constraint. -/
349349
naturality {a b : B} (f : a ⟶ b) : η.app a ≫ G.map f ≅ F.map f ≫ η.app b

Mathlib/CategoryTheory/Bicategory/NaturalTransformation/Oplax.lean

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,33 @@ Just as there are natural transformations between functors, there are transforma
1515
between oplax functors. The equality in the naturality condition of a natural transformation gets
1616
replaced by a specified 2-morphism. Now, there are three possible types of transformations (between
1717
oplax functors):
18-
* Oplax natural transformations;
19-
* Lax natural transformations;
20-
* Strong natural transformations.
18+
* oplax natural transformations;
19+
* lax natural transformations;
20+
* strong natural transformations.
2121
These differ in the direction (and invertibility) of the 2-morphisms involved in the naturality
2222
condition.
2323
2424
## Main definitions
2525
26-
* `Oplax.LaxTrans F G`: oplax transformations between oplax functors `F` and `G`. The naturality
26+
* `Oplax.LaxTrans F G`: lax transformations between oplax functors `F` and `G`. The naturality
2727
condition is given by a 2-morphism `app a ≫ G.map f ⟶ F.map f ≫ app b` for each 1-morphism
2828
`f : a ⟶ b`.
2929
* `Oplax.OplaxTrans F G`: oplax transformations between oplax functors `F` and `G`. The naturality
3030
condition is given by a 2-morphism `F.map f ≫ app b ⟶ app a ≫ G.map f` for each 1-morphism
3131
`f : a ⟶ b`.
32-
* `Oplax.StrongTrans F G`: Strong transformations between oplax functors `F` and `G`. The naturality
32+
* `Oplax.StrongTrans F G`: strong transformations between oplax functors `F` and `G`. The naturality
3333
condition is given by a 2-isomorphism `F.map f ≫ app b ≅ app a ≫ G.map f` for each 1-morphism
3434
`f : a ⟶ b`.
3535
36-
Using these, we define three `CategoryStruct` (scoped) instances on `B ⥤ᵒᵖᴸ C`, in the
36+
Using these, we define three (scoped) `CategoryStruct` instances on `B ⥤ᵒᵖᴸ C`, in the
3737
`Oplax.LaxTrans`, `Oplax.OplaxTrans`, and `Oplax.StrongTrans` namespaces. The arrows in these
38-
CategoryStruct's are given by lax transformations, oplax transformations, and strong
38+
`CategoryStruct` instances are given by lax transformations, oplax transformations, and strong
3939
transformations respectively.
4040
4141
We also provide API for going between oplax transformations and strong transformations:
42-
* `Oplax.StrongCore F G`: a structure on an oplax transformation between oplax functors that
42+
* `OplaxTrans.StrongCore η`: a structure on an oplax transformation between oplax functors that
4343
promotes it to a strong transformation.
44-
* `Oplax.mkOfOplax η η'`: given an oplax transformation `η` such that each component
44+
* `StrongTrans.mkOfOplax η η'`: given an oplax transformation `η` such that each component
4545
2-morphism is an isomorphism, `mkOfOplax` gives the corresponding strong transformation.
4646
4747
## References
@@ -66,9 +66,9 @@ These 2-morphisms satisfy the naturality condition, and preserve the identities
6666
the compositions modulo some adjustments of domains and codomains of 2-morphisms.
6767
-/
6868
structure LaxTrans (F G : OplaxFunctor B C) where
69-
/-- The component 1-morphisms of an oplax transformation. -/
69+
/-- The component 1-morphisms of a lax transformation. -/
7070
app (a : B) : F.obj a ⟶ G.obj a
71-
/-- The 2-morphisms underlying the oplax naturality constraint. -/
71+
/-- The 2-morphisms underlying the lax naturality constraint. -/
7272
naturality {a b : B} (f : a ⟶ b) : app a ≫ G.map f ⟶ F.map f ≫ app b
7373
naturality_naturality {a b : B} {f g : a ⟶ b} (η : f ⟶ g) :
7474
naturality f ≫ F.map₂ η ▷ app b = app a ◁ G.map₂ η ≫ naturality g := by
@@ -309,7 +309,7 @@ that is "natural up to 2-isomorphisms".
309309
310310
More precisely, it consists of the following:
311311
* a 1-morphism `η.app a : F.obj a ⟶ G.obj a` for each object `a : B`.
312-
* a 2-isomorphism `η.naturality f : F.map f ≫ app b app a ≫ G.map f` for each 1-morphism
312+
* a 2-isomorphism `η.naturality f : F.map f ≫ app b app a ≫ G.map f` for each 1-morphism
313313
`f : a ⟶ b`.
314314
* These 2-isomorphisms satisfy the naturality condition, and preserve the identities and the
315315
compositions modulo some adjustments of domains and codomains of 2-morphisms.
@@ -338,7 +338,7 @@ attribute [reassoc (attr := simp)] StrongTrans.naturality_naturality
338338

339339
/-- A structure on an oplax transformation that promotes it to a strong transformation.
340340
341-
See `Pseudofunctor.StrongTrans.mkOfOplax`. -/
341+
See `StrongTrans.mkOfOplax`. -/
342342
structure OplaxTrans.StrongCore {F G : B ⥤ᵒᵖᴸ C} (η : F ⟶ G) where
343343
/-- The underlying 2-isomorphisms of the naturality constraint. -/
344344
naturality {a b : B} (f : a ⟶ b) : F.map f ≫ η.app b ≅ η.app a ≫ G.map f

Mathlib/CategoryTheory/Bicategory/NaturalTransformation/Pseudo.lean

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ In this file we define strong transformations, which require the 2-morphism to b
2020
## Main definitions
2121
2222
* `Pseudofunctor.StrongTrans F G`: strong transformations between pseudofunctors `F` and `G`.
23-
* `Pseudofunctor.mkOfOplax η η'`: Given two pseudofunctors, and a strong transformation `η` between
24-
their underlying oplax functors, `mkOfOplax` lifts this to a strong transformation between the
23+
* `Pseudofunctor.StrongTrans.mkOfOplax η`: given a strong transformation `η` between the
24+
underlying oplax functors, `mkOfOplax` lifts this to a strong transformation between the
2525
pseudofunctors.
2626
* `Pseudofunctor.StrongTrans.vcomp η θ`: the vertical composition of strong transformations `η`
2727
and `θ`.
2828
29-
Using this we obtain a (scoped) `CategoryStruct` on pseudofunctors, where the arrows are given by
29+
Using this, we obtain a (scoped) `CategoryStruct` on pseudofunctors, where the arrows are given by
3030
strong transformations. To access this instance, run `open scoped Pseudofunctor.StrongTrans`.
3131
See `Pseudofunctor.StrongTrans.categoryStruct`.
3232

0 commit comments

Comments
 (0)