Skip to content

Commit 92e32a5

Browse files
authored
Merge pull request AVSystem#705 from Nepommuck/opt-typo-fix
Fix a typo in `com.avsystem.commons.misc.Opt` documentation
2 parents da3533a + a251f9e commit 92e32a5

File tree

1 file changed

+5
-5
lines changed
  • core/src/main/scala/com/avsystem/commons/misc

1 file changed

+5
-5
lines changed

core/src/main/scala/com/avsystem/commons/misc/Opt.scala

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ object Opt {
3131

3232
final class LazyOptOps[A](private val opt: () => Opt[A]) extends AnyVal {
3333
/** When a given condition is true, evaluates the `opt` argument and returns it.
34-
* When the condition is false, `opt` is not evaluated and `Opt.Empty` is
34+
* When the condition is false, `opt` is not evaluated and [[Opt.Empty]] is
3535
* returned.
3636
*/
3737
def when(cond: Boolean): Opt[A] = if (cond) opt() else Opt.Empty
3838
/** Unless a given condition is true, this will evaluate the `opt` argument and
39-
* return it. Otherwise, `opt` is not evaluated and `Opt.Empty` is returned.
39+
* return it. Otherwise, `opt` is not evaluated and [[Opt.Empty]] is returned.
4040
*/
4141
@inline def unless(cond: Boolean): Opt[A] = when(!cond)
4242
}
@@ -45,13 +45,13 @@ object Opt {
4545
}
4646

4747
/**
48-
* Like `Option` but implemented as value class (avoids boxing) and treats `null` as no value.
48+
* Like [[Option]] but implemented as value class (avoids boxing) and treats `null` as no value.
4949
* Therefore, there is no equivalent for `Some(null)`.
5050
*
51-
* If you need a value-class version of `Option` which differentiates between no value and `null` value,
51+
* If you need a value-class version of [[Option]] which differentiates between no value and `null` value,
5252
* use [[NOpt]].
5353
*
54-
* WARNING: Unfortunately, using `Opt` in pattern matches turns of exhaustivity checking.
54+
* WARNING: Unfortunately, using `Opt` in pattern matches turns off the exhaustivity checking.
5555
* Please be aware of that tradeoff.
5656
*/
5757
final class Opt[+A] private(private val rawValue: Any) extends AnyVal with OptBase[A] with Serializable {

0 commit comments

Comments
 (0)