summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorringabout <43030857+ringabout@users.noreply.github.com>2022-11-13 04:05:57 +0800
committerGitHub <noreply@github.com>2022-11-12 21:05:57 +0100
commit73680cef953bd9c42b7c7c4e8081d0ae609de772 (patch)
tree1ffcb7080a47bb7531f10c6dd9d67091ddc685eb
parentbf0c17c9bc8bc63b5556b6a58fe1e082d98ac173 (diff)
downloadNim-73680cef953bd9c42b7c7c4e8081d0ae609de772.tar.gz
[minor] documentation improvement (#20825)
[minor] documentation improvament
-rw-r--r--lib/std/decls.nim8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/std/decls.nim b/lib/std/decls.nim
index 7b907f5e1..fc202522f 100644
--- a/lib/std/decls.nim
+++ b/lib/std/decls.nim
@@ -7,10 +7,10 @@ macro byaddr*(sect) =
   ## Allows a syntax for l-value references, being an exact analog to
   ## `auto& a = ex;` in C++.
   ## 
-  ## Warning: This makes use of 2 experimental features, namely nullary
-  ## templates instantiated as symbols and variable macro pragmas.
-  ## For this reason, its behavior is not stable. The current implementation
-  ## allows redefinition, but this is not an intended consequence.
+  ## .. warning:: This makes use of 2 experimental features, namely nullary
+  ##   templates instantiated as symbols and variable macro pragmas.
+  ##   For this reason, its behavior is not stable. The current implementation
+  ##   allows redefinition, but this is not an intended consequence.
   runnableExamples:
     var s = @[10, 11, 12]
     var a {.byaddr.} = s[0]