diff options
Diffstat (limited to 'lib/pure/options.nim')
| -rw-r--r-- | lib/pure/options.nim | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/pure/options.nim b/lib/pure/options.nim index ad63bbcb6..6d2869bff 100644 --- a/lib/pure/options.nim +++ b/lib/pure/options.nim @@ -153,7 +153,10 @@ proc `==`*(a, b: Option): bool = (a.has and b.has and a.val == b.val) or (not a.has and not b.has) proc `$`*[T](self: Option[T]): string = - ## Returns the contents of this option or `otherwise` if the option is none. + ## Get the string representation of this option. If the option has a value, + ## the result will be `Some(x)` where `x` is the string representation of the contained value. + ## If the option does not have a value, the result will be `None[T]` where `T` is the name of + ## the type contained in the option. if self.has: "Some(" & $self.val & ")" else: |