Commit 8662c0ff43aad7191b063047c71384e868086d6f | zig

author	Andrew Kelley <andrew@ziglang.org> 2024-01-18 20:58:35-07:00
committer	Andrew Kelley <andrew@ziglang.org> 2024-01-18 22:01:09-07:00
log	8662c0ff43aad7191b063047c71384e868086d6f
tree	f4003dec357690313fd9e0348de49e4ac9bdb614
parent	9e6ff713300295150a02c6ab12852d325d92559a

See #2402

1 files changed, 7 insertions(+), 4 deletions(-)

doc/langref.html.in+7-4

 @@ -2788,9 +2788,11 @@ test "volatile" {
       </p>
       {#header_close#}
       <p>
-      To convert one pointer type to another, use {#link|@ptrCast#}. This is an unsafe
+      {#link|@ptrCast#} converts a pointer's element type to another. This
-      operation that Zig cannot protect you against. Use {#syntax#}@ptrCast{#endsyntax#} only when other
+      creates a new pointer that can cause undetectable illegal behavior
-      conversions are not possible.
+      depending on the loads and stores that pass through it. Generally, other
+      kinds of type conversions are preferable to
+      {#syntax#}@ptrCast{#endsyntax#} if possible.
       </p>
       {#code_begin|test|test_pointer_casting#}
 const std = @import("std");
 @@ -8592,7 +8594,8 @@ test "decl access by string" {
       <pre>{#syntax#}@floatFromInt(int: anytype) anytype{#endsyntax#}</pre>
       <p>
       Converts an integer to the closest floating point representation. The return type is the inferred result type.
-			To convert the other way, use {#link|@intFromFloat#}. This cast is always safe.
+			To convert the other way, use {#link|@intFromFloat#}. This operation is legal
+      for all values of all integer types.
       </p>
       {#header_close#}