summary refs log tree commit diff stats
path: root/lib/pure/options.nim
diff options
context:
space:
mode:
authorAndreas Rumpf <rumpf_a@web.de>2017-11-02 10:46:30 +0100
committerAndreas Rumpf <rumpf_a@web.de>2017-11-02 10:46:30 +0100
commit1eaeccc15d15d15d2f62ea1648f7dd64722dbd37 (patch)
treeb922cdabc780fa3a8837a6804d2df31793d9e2ca /lib/pure/options.nim
parente9243a16167b24899d4fcf051f3252b3a5804811 (diff)
parentbd19b5f4d36bb40b4af93d7e15fdfa582e9fe3b7 (diff)
downloadNim-1eaeccc15d15d15d2f62ea1648f7dd64722dbd37.tar.gz
Merge branch 'devel' into araq
Diffstat (limited to 'lib/pure/options.nim')
-rw-r--r--lib/pure/options.nim5
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: