fix comments

nim-lang · Jan 23, 2020 · 0e66b9a · 0e66b9a
1 parent 6b48b9d
commit 0e66b9a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/changelog.md b/changelog.md
@@ -55,7 +55,7 @@
 
 - Added `os.isRelativeTo` to tell whether a path is relative to another
 
-- Added `sugar.byAddr` allowing a ref syntax for lvalue expressions
+- Added `sugar.byAddr` allowing a reference syntax for lvalue expressions, analog to C++ `auto& a = expr`.
 
 ## Library changes
 

diff --git a/lib/pure/sugar.nim b/lib/pure/sugar.nim
@@ -384,9 +384,9 @@ proc splitDefinition*(def: NimNode): tuple[lhs: NimNode, rhs: NimNode, exported:
   expectKind(result.lhs, nnkIdent)
 
 macro byAddr*(def: untyped): untyped {.since: (1,1).} =
-  ## Defines a ref alias for lvalue expressions. The expression is evaluated
-  ## only once, and any side effects will only be evaluated once, at declaration
-  ## time.
+  ## Defines a reference syntax for lvalue expressions, analog to C++ `auto& a = expr`.
+  ## The expression is evaluated only once, and any side effects will only be
+  ## evaluated once, at declaration time.
   runnableExamples:
     var x = @[1,2,3]
     byAddr: x1=x[1]