Skip to content

Commit 0e83422

Browse files
doc: add missing docstrings for Rxy.Sliceable (#11472)
This PR adds missing docstrings for the `mkSlice` methods.
1 parent 3dd99fc commit 0e83422

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/Init/Data/Slice/Notation.lean

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ prelude
99
public import Init.Data.Range.Polymorphic.PRange
1010

1111
set_option doc.verso true
12+
set_option linter.missingDocs true
1213

1314
public section
1415

@@ -30,6 +31,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
3031
The type of the resulting slices is {lit}`γ`.
3132
-/
3233
class Rcc.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
34+
/--
35+
Slices {name}`carrier` from {lean}`range.lower` to {lean}`range.upper`, both inclusive.
36+
-/
3337
mkSlice (carrier : α) (range : Rcc β) : γ
3438

3539
/--
@@ -39,6 +43,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
3943
The type of resulting the slices is {lit}`γ`.
4044
-/
4145
class Rco.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
46+
/--
47+
Slices {name}`carrier` from {lean}`range.lower` (inclusive) to {lean}`range.upper` (exclusive).
48+
-/
4249
mkSlice (carrier : α) (range : Rco β) : γ
4350

4451
/--
@@ -48,6 +55,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
4855
The type of the resulting slices is {lit}`γ`.
4956
-/
5057
class Rci.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
58+
/--
59+
Slices {name}`carrier` from {lean}`range.lower` (inclusive).
60+
-/
5161
mkSlice (carrier : α) (range : Rci β) : γ
5262

5363
/--
@@ -57,6 +67,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
5767
The type of the resulting slices is {lit}`γ`.
5868
-/
5969
class Roc.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
70+
/--
71+
Slices {name}`carrier` from {lean}`range.lower` (exclusive) to {lean}`range.upper` (inclusive).
72+
-/
6073
mkSlice (carrier : α) (range : Roc β) : γ
6174

6275
/--
@@ -66,6 +79,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
6679
The type of the resulting slices is {lit}`γ`.
6780
-/
6881
class Roo.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
82+
/--
83+
Slices {name}`carrier` from {lean}`range.lower` to {lean}`range.upper`, both exclusive.
84+
-/
6985
mkSlice (carrier : α) (range : Roo β) : γ
7086

7187
/--
@@ -75,6 +91,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
7591
The type of the resulting slices is {lit}`γ`.
7692
-/
7793
class Roi.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
94+
/--
95+
Slices {name}`carrier` from {lean}`range.lower` (exclusive).
96+
-/
7897
mkSlice (carrier : α) (range : Roi β) : γ
7998

8099
/--
@@ -84,6 +103,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
84103
The type of the resulting slices is {lit}`γ`.
85104
-/
86105
class Ric.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
106+
/--
107+
Slices {name}`carrier` up to {lean}`range.upper` (inclusive).
108+
-/
87109
mkSlice (carrier : α) (range : Ric β) : γ
88110

89111
/--
@@ -93,6 +115,9 @@ This typeclass indicates how to obtain slices of elements of {lit}`α` over rang
93115
The type of the resulting slices is {lit}`γ`.
94116
-/
95117
class Rio.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
118+
/--
119+
Slices {name}`carrier` up to {lean}`range.upper` (exclusive).
120+
-/
96121
mkSlice (carrier : α) (range : Rio β) : γ
97122

98123
/--
@@ -102,6 +127,9 @@ index type {lit}`β`.
102127
The type of the resulting slices is {lit}`γ`.
103128
-/
104129
class Rii.Sliceable (α : Type u) (β : outParam (Type v)) (γ : outParam (Type w)) where
130+
/--
131+
Slices {name}`carrier` with no bounds.
132+
-/
105133
mkSlice (carrier : α) (range : Rii β) : γ
106134

107135
macro_rules

0 commit comments

Comments
 (0)