zig

commit 6d73e5de058ea421a98a53ae6c0844860715cc01 (tree)
parent 0ccd91faea5ec27a1dce9d3bae84e1feca7fc0ea
Author: Shritesh Bhattarai <shritesh@shritesh.com>
Date:   Thu, 30 May 2019 19:38:26 -0700

doc: recommend optional pointers for nullptrs instead of allowzero

Diffstat:
M
doc/langref.html.in
 | 
6
+++---

1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/langref.html.in b/doc/langref.html.in
@@ -2026,9 +2026,9 @@ fn foo(bytes: []u8) u32 {
       {#header_open|allowzero#}
       <p>
       This pointer attribute allows a pointer to have address zero. This is only ever needed on the
-      freestanding OS target, where the address zero is mappable. In this code example, if the pointer
-      did not have the {#syntax#}allowzero{#endsyntax#} attribute, this would be a
-      {#link|Pointer Cast Invalid Null#} panic:
+      freestanding OS target, where the address zero is mappable. If you want to represent null pointers, use
+      {#link|Optional Pointers#} instead. In this code example, if the pointer did not have the
+      {#syntax#}allowzero{#endsyntax#} attribute, this would be a {#link|Pointer Cast Invalid Null#} panic:
       </p>
       {#code_begin|test|allowzero#}
 const std = @import("std");