Commit ef93a36cd5b783d50b595f5f7eea7422649081a7 | zig

author	Gordon Cassie <gordoncassie@gmail.com> 2023-12-07 13:51:03-08:00
committer	Gordon Cassie <gordoncassie@gmail.com> 2023-12-07 13:51:03-08:00
log	ef93a36cd5b783d50b595f5f7eea7422649081a7
tree	5c47c4991f433a36f94eb074ed89f996827d20e0
parent	cce820f93d0648d39f862a5784850580cb2cf4bb

Add comment. Split up if docs for optionals.

1 files changed, 48 insertions(+), 40 deletions(-)

doc
- langref.html.in

doc/langref.html.in+48-40

 @@ -4628,6 +4628,7 @@ test "while null capture" {
     }
     try expect(sum1 == 3);
+    // null capture with an else block
     var sum2: u32 = 0;
     numbers_left = 3;
     while (eventuallyNullSequence()) |value| {
 @@ -4636,6 +4637,7 @@ test "while null capture" {
         try expect(sum2 == 3);
     }
+    // null capture with a continue expression
     var i: u32 = 0;
     var sum3: u32 = 0;
     numbers_left = 3;
 @@ -4923,87 +4925,92 @@ test "if boolean" {
     }
 }
-test "if optional" {
+test "if error union" {
-    // If expressions test for null.
+    // If expressions test for errors.
+    // Note the |err| capture on the else.
-    const a: ?u32 = 0;
+    const a: anyerror!u32 = 0;
     if (a) |value| {
         try expect(value == 0);
-    } else {
+    } else |err| {
+        _ = err;
         unreachable;
     }
-    const b: ?u32 = null;
+    const b: anyerror!u32 = error.BadValue;
-    if (b) |_| {
+    if (b) |value| {
+        _ = value;
         unreachable;
-    } else {
+    } else |err| {
-        try expect(true);
+        try expect(err == error.BadValue);
     }
-    // The else is not required.
+    // The else and |err| capture is strictly required.
     if (a) |value| {
         try expect(value == 0);
-    }
+    } else |_| {}
-    // To test against null only, use the binary equality operator.
+    // To check only the error value, use an empty block expression.
-    if (b == null) {
+    if (b) |_| {} else |err| {
-        try expect(true);
+        try expect(err == error.BadValue);
     }
     // Access the value by reference using a pointer capture.
-    var c: ?u32 = 3;
+    var c: anyerror!u32 = 3;
     if (c) |*value| {
-        value.* = 2;
+        value.* = 9;
+    } else |_| {
+        unreachable;
     }
     if (c) |value| {
-        try expect(value == 2);
+        try expect(value == 9);
-    } else {
+    } else |_| {
         unreachable;
     }
 }
+      {#code_end#}
+      {#header_open|if with Optionals#}
-test "if error union" {
+      {#code_begin|test|test_if_optionals#}
-    // If expressions test for errors.
+const expect = @import("std").testing.expect;
-    // Note the |err| capture on the else.
-    const a: anyerror!u32 = 0;
+test "if optional" {
+    // If expressions test for null.
+    const a: ?u32 = 0;
     if (a) |value| {
         try expect(value == 0);
-    } else |err| {
+    } else {
-        _ = err;
         unreachable;
     }
-    const b: anyerror!u32 = error.BadValue;
+    const b: ?u32 = null;
-    if (b) |value| {
+    if (b) |_| {
-        _ = value;
         unreachable;
-    } else |err| {
+    } else {
-        try expect(err == error.BadValue);
+        try expect(true);
     }
-    // The else and |err| capture is strictly required.
+    // The else is not required.
     if (a) |value| {
         try expect(value == 0);
-    } else |_| {}
+    }
-    // To check only the error value, use an empty block expression.
+    // To test against null only, use the binary equality operator.
-    if (b) |_| {} else |err| {
+    if (b == null) {
-        try expect(err == error.BadValue);
+        try expect(true);
     }
     // Access the value by reference using a pointer capture.
-    var c: anyerror!u32 = 3;
+    var c: ?u32 = 3;
     if (c) |*value| {
-        value.* = 9;
+        value.* = 2;
-    } else |_| {
-        unreachable;
     }
     if (c) |value| {
-        try expect(value == 9);
+        try expect(value == 2);
-    } else |_| {
+    } else {
         unreachable;
     }
 }
 @@ -5052,6 +5059,7 @@ test "if error union with optional" {
     }
 }
       {#code_end#}
+      {#header_close#}
       {#see_also|Optionals|Errors#}
       {#header_close#}
       {#header_open|defer#}
 @@ -6338,7 +6346,7 @@ test "optional pointers" {
       {#code_end#}
       {#header_close#}
-      {#see_also|while with Optionals|if#}
+      {#see_also|while with Optionals|if with Optionals#}
       {#header_close#}
       {#header_open|Casting#}
       <p>