Amend optionals docstring

This commit is contained in:
Flaviu Tamas
2015-05-26 09:21:15 -04:00
parent d3ab60c831
commit f9e95b2987

View File

@@ -97,7 +97,7 @@ proc isNone*[T](self: Option[T]): bool =
proc unsafeGet*[T](self: Option[T]): T =
## Returns the value of a `just`. Behavior is undefined for `none`.
## Returns the value of a ``some``. Behavior is undefined for ``none``.
assert self.isSome
self.val
@@ -110,7 +110,7 @@ proc get*[T](self: Option[T]): T =
proc `==`*(a, b: Option): bool =
## Returns ``true`` if both ``Option``s are `none`,
## Returns ``true`` if both ``Option``s are ``none``,
## or if they have equal values
(a.has and b.has and a.val == b.val) or (not a.has and not b.has)