mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-04-26 09:14:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for the $ proc on an option (#6449)

Browse Source
This commit is contained in:
Euan T
2017-10-02 15:11:53 +01:00
committed by Andreas Rumpf
parent 535f21ced3
commit 4617114453
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lib/pure/options.nim
View File

@@ -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: