Skip to content

Commit 7e0a1db

Browse files
committed
Address reviewer feedback about singleton ops code documentation
Remove unnecessary comments about singleton ops being type-level equivalents of term-level operations
1 parent 8c117c1 commit 7e0a1db

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

library/src/scala/compiletime/ops/package.scala

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -33,103 +33,103 @@ package object ops {
3333
}
3434

3535
object int {
36-
/** Addition of two `Int` singleton types. Type-level equivalent of `scala.Int.+`
36+
/** Addition of two `Int` singleton types.
3737
* ```scala
3838
* val sum: 2 + 2 = 4
3939
* ```
4040
*/
4141
@infix type +[X <: Int, Y <: Int] <: Int
4242

43-
/** Subtraction of two `Int` singleton types. Type-level equivalent of `scala.Int.-`
43+
/** Subtraction of two `Int` singleton types.
4444
* ```scala
4545
* val sub: 4 - 2 = 2
4646
* ```
4747
*/
4848
@infix type -[X <: Int, Y <: Int] <: Int
4949

50-
/** Multiplication of two `Int` singleton types. Type-level equivalent of `scala.Int.*`
50+
/** Multiplication of two `Int` singleton types.
5151
* ```scala
5252
* val mul: 4 * 2 = 8
5353
* ```
5454
*/
5555
@infix type *[X <: Int, Y <: Int] <: Int
5656

57-
/** Integer division of two `Int` singleton types. Type-level equivalent of `scala.Int./`
57+
/** Integer division of two `Int` singleton types.
5858
* ```scala
5959
* val div: 5 / 2 = 2
6060
* ```
6161
*/
6262
@infix type /[X <: Int, Y <: Int] <: Int
6363

64-
/** Remainder of the division of `X` by `Y`. Type-level equivalent of `scala.Int.%`
65-
* ```scala
64+
/** Remainder of the division of `X` by `Y`.
65+
* ```scala
6666
* val mod: 5 % 2 = 1
6767
* ```
6868
*/
6969
@infix type %[X <: Int, Y <: Int] <: Int
7070

71-
/** Less-than comparison of two `Int` singleton types. Type-level equivalent of `scala.Int.<`.
71+
/** Less-than comparison of two `Int` singleton types.
7272
* ```scala
7373
* val lt1: 4 < 2 = false
7474
* val lt2: 2 < 4 = true
7575
* ```
7676
*/
7777
@infix type <[X <: Int, Y <: Int] <: Boolean
7878

79-
/** Greater-than comparison of two `Int` singleton types. Type-level equivalent of `scala.Int.>`.
79+
/** Greater-than comparison of two `Int` singleton types.
8080
* ```scala
8181
* val gt1: 4 > 2 = true
8282
* val gt2: 2 > 2 = false
8383
* ```
8484
*/
8585
@infix type >[X <: Int, Y <: Int] <: Boolean
8686

87-
/** Greater-or-equal comparison of two `Int` singleton types. Type-level equivalent of `scala.Int.>=`.
87+
/** Greater-or-equal comparison of two `Int` singleton types.
8888
* ```scala
8989
* val ge1: 4 >= 2 = true
9090
* val ge2: 2 >= 3 = false
9191
* ```
9292
*/
9393
@infix type >=[X <: Int, Y <: Int] <: Boolean
9494

95-
/** Less-or-equal comparison of two `Int` singleton types. Type-level equivalent of `scala.Int.<=`.
95+
/** Less-or-equal comparison of two `Int` singleton types.
9696
* ```scala
9797
* val lt1: 4 <= 2 = false
9898
* val lt2: 2 <= 2 = true
9999
* ```
100100
*/
101101
@infix type <=[X <: Int, Y <: Int] <: Boolean
102102

103-
/** Absolute value of an `Int` singleton type. Type-level equivalent of `scala.Int.abs`.
103+
/** Absolute value of an `Int` singleton type.
104104
* ```scala
105105
* val abs: Abs[-1] = 1
106106
* ```
107107
*/
108108
type Abs[X <: Int] <: Int
109109

110-
/** Negation of an `Int` singleton type. Type-level equivalent of `scala.Int.unary_-`.
110+
/** Negation of an `Int` singleton type.
111111
* ```scala
112112
* val neg1: Neg[-1] = 1
113113
* val neg2: Neg[1] = -1
114114
* ```
115115
*/
116116
type Negate[X <: Int] <: Int
117117

118-
/** Minimum of two `Int` singleton types. Type-level equivalent of `scala.Int.min`.
118+
/** Minimum of two `Int` singleton types.
119119
* ```scala
120120
* val min: Min[-1, 1] = -1
121121
* ```
122122
*/
123123
type Min[X <: Int, Y <: Int] <: Int
124124

125-
/** Maximum of two `Int` singleton types. Type-level equivalent of `scala.Int.max`.
125+
/** Maximum of two `Int` singleton types.
126126
* ```scala
127127
* val abs: Abs[-1] = 1
128128
* ```
129129
*/
130130
type Max[X <: Int, Y <: Int] <: Int
131131

132-
/** String conversion of an `Int` singleton type. Type-level equivalent of `scala.Int.toString`.
132+
/** String conversion of an `Int` singleton type.
133133
* ```scala
134134
* val abs: ToString[1] = "1"
135135
* ```
@@ -139,31 +139,31 @@ package object ops {
139139

140140
object boolean {
141141

142-
/** Negation of a `Boolean` singleton type. Type-level equivalent of `scala.Boolean.unary_!`.
142+
/** Negation of a `Boolean` singleton type.
143143
* ```scala
144144
* val notFalse: ![false] = true
145145
* val notTrue: ![true] = false
146146
* ```
147147
*/
148148
type ![X <: Boolean] <: Boolean
149149

150-
/** Exclusive disjunction of two `Boolean` singleton types. Type-level equivalent of `scala.Boolean.^`.
150+
/** Exclusive disjunction of two `Boolean` singleton types.
151151
* ```scala
152152
* val a: true ^ true = false
153153
* val b: false ^ true = true
154154
* ```
155155
*/
156156
@infix type ^[X <: Boolean, Y <: Boolean] <: Boolean
157157

158-
/** Conjunction of two `Boolean` singleton types. Type-level equivalent of `scala.Boolean.&&`.
158+
/** Conjunction of two `Boolean` singleton types.
159159
* ```scala
160160
* val a: true && true = true
161161
* val b: false && true = false
162162
* ```
163163
*/
164164
@infix type &&[X <: Boolean, Y <: Boolean] <: Boolean
165165

166-
/** Disjunction of two `Boolean` singleton types. Type-level equivalent of `scala.Boolean.||`.
166+
/** Disjunction of two `Boolean` singleton types.
167167
* ```scala
168168
* val a: true || false = true
169169
* val b: false || false = false

0 commit comments

Comments
 (0)