Commit 07b7c3b31babc0763199fe39db875298d2cc12a6 | zig

author	Matthew Lugg <mlugg@mlugg.co.uk> 2023-04-15 01:19:37+01:00
committer	Andrew Kelley <andrew@ziglang.org> 2023-04-18 19:57:47-07:00
log	07b7c3b31babc0763199fe39db875298d2cc12a6
tree	d32af40b572f4a621d3d84f83dcfe884c00f1a1e
parent	0eebc258809beac9779af48216b01c5c20cbbfea

doc: clarifications to comptime section in langref after #14819

1 files changed, 8 insertions(+), 14 deletions(-)

doc
- langref.html.in

doc/langref.html.in+8-14

 @@ -7048,8 +7048,10 @@ test "foo" {
           <li>All variables are {#syntax#}comptime{#endsyntax#} variables.</li>
           <li>All {#syntax#}if{#endsyntax#}, {#syntax#}while{#endsyntax#}, {#syntax#}for{#endsyntax#}, and {#syntax#}switch{#endsyntax#}
           expressions are evaluated at compile-time, or emit a compile error if this is not possible.</li>
-        <li>All function calls cause the compiler to interpret the function at compile-time, emitting a
+          <li>All {#syntax#}return{#endsyntax#} and {#syntax#}try{#endsyntax#} expressions are invalid (unless the function itself is called at compile-time).</li>
-          compile error if the function tries to do something that has global run-time side effects.</li>
+          <li>All code with runtime side effects or depending on runtime values emits a compile error.</li>
+          <li>All function calls cause the compiler to interpret the function at compile-time, emitting a
+          compile error if the function tries to do something that has global runtime side effects.</li>
       </ul>
       <p>
       This means that a programmer can create a function which is called both at compile-time and run-time, with
 @@ -7071,9 +7073,7 @@ test "fibonacci" {
     try expect(fibonacci(7) == 13);
     // test fibonacci at compile-time
-    comptime {
+    try comptime expect(fibonacci(7) == 13);
-        try expect(fibonacci(7) == 13);
-    }
 }
       {#code_end#}
       <p>
 @@ -7088,9 +7088,7 @@ fn fibonacci(index: u32) u32 {
 }
 test "fibonacci" {
-    comptime {
+    try comptime expect(fibonacci(7) == 13);
-        try expect(fibonacci(7) == 13);
-    }
 }
       {#code_end#}
       <p>
 @@ -7111,9 +7109,7 @@ fn fibonacci(index: i32) i32 {
 }
 test "fibonacci" {
-    comptime {
+    try comptime assert(fibonacci(7) == 13);
-        try assert(fibonacci(7) == 13);
-    }
 }
       {#code_end#}
       <p>
 @@ -7143,9 +7139,7 @@ fn fibonacci(index: i32) i32 {
 }
 test "fibonacci" {
-    comptime {
+    try comptime assert(fibonacci(7) == 99999);
-        try assert(fibonacci(7) == 99999);
-    }
 }
       {#code_end#}