Fix documentation for the $ proc on an option (#6449)
This commit is contained in:
parent
535f21ced3
commit
4617114453
1 changed files with 4 additions and 1 deletions
|
|
@ -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)
|
(a.has and b.has and a.val == b.val) or (not a.has and not b.has)
|
||||||
|
|
||||||
proc `$`*[T](self: Option[T]): string =
|
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:
|
if self.has:
|
||||||
"Some(" & $self.val & ")"
|
"Some(" & $self.val & ")"
|
||||||
else:
|
else:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue