diff options
| author | zooster <r00ster91@proton.me> | 2023-04-23 20:06:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-23 21:06:21 +0300 |
| commit | bc8e1e1de4a2f22c56528240d320f682f1ec4b69 (patch) | |
| tree | ad2bd1a996d5cb74570e22bda1adc00c59867c08 /src/Sema.zig | |
| parent | 658b4db223c24616a95cdf3bb3226caa23a3b50e (diff) | |
| download | zig-bc8e1e1de4a2f22c56528240d320f682f1ec4b69.tar.gz zig-bc8e1e1de4a2f22c56528240d320f682f1ec4b69.zip | |
Improvements to docs and text
* docs(std.math): elaborate on difference between absCast and absInt
* docs(std.rand.Random.weightedIndex): elaborate on likelihood
I think this makes it easier to understand.
* langref: add small reminder
* docs(std.fs.path.extension): brevity
* docs(std.bit_set.StaticBitSet): mention the specific types
* std.debug.TTY: explain what purpose this struct serves
This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging.
* langref(package listing): brevity
* langref: explain what exactly `threadlocal` causes to happen
* std.array_list: link between swapRemove and orderedRemove
Maybe this can serve as a TLDR and make it easier to decide.
* PrefetchOptions.locality: clarify docs that this is a range
This confused me previously and I thought I can only use either 0 or 3.
* fix typos and more
* std.builtin.CallingConvention: document some CCs
* langref: explain possibly cryptic names
I think it helps knowing what exactly these acronyms (@clz and @ctz) and
abbreviations (@popCount) mean.
* variadic function error: add missing preposition
* std.fmt.format docs: nicely hyphenate
* help menu: say what to optimize for
I think this is slightly more specific than just calling it
"optimizations". These are speed optimizations. I used the word
"performance" here.
Diffstat (limited to 'src/Sema.zig')
| -rw-r--r-- | src/Sema.zig | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/Sema.zig b/src/Sema.zig index 5c19d37431..4deb2b0f29 100644 --- a/src/Sema.zig +++ b/src/Sema.zig @@ -4155,7 +4155,7 @@ fn validateUnionInit( const msg = try sema.errMsg( block, init_src, - "cannot initialize multiple union fields at once, unions can only have one active field", + "cannot initialize multiple union fields at once; unions can only have one active field", .{}, ); errdefer msg.destroy(sema.gpa); @@ -9646,7 +9646,7 @@ fn zirBitcast(sema: *Sema, block: *Block, inst: Zir.Inst.Index) CompileError!Air .Union => "union", else => unreachable, }; - return sema.fail(block, dest_ty_src, "cannot @bitCast to '{}', {s} does not have a guaranteed in-memory layout", .{ + return sema.fail(block, dest_ty_src, "cannot @bitCast to '{}'; {s} does not have a guaranteed in-memory layout", .{ dest_ty.fmt(sema.mod), container, }); }, @@ -9709,7 +9709,7 @@ fn zirBitcast(sema: *Sema, block: *Block, inst: Zir.Inst.Index) CompileError!Air .Union => "union", else => unreachable, }; - return sema.fail(block, operand_src, "cannot @bitCast from '{}', {s} does not have a guaranteed in-memory layout", .{ + return sema.fail(block, operand_src, "cannot @bitCast from '{}'; {s} does not have a guaranteed in-memory layout", .{ operand_ty.fmt(sema.mod), container, }); }, @@ -26434,7 +26434,7 @@ fn coerceVarArgParam( .ComptimeInt, .ComptimeFloat => return sema.fail( block, inst_src, - "integer and float literals passed variadic function must be casted to a fixed-size number type", + "integer and float literals passed to variadic function must be casted to a fixed-size number type", .{}, ), .Fn => blk: { @@ -27891,7 +27891,7 @@ fn coerceAnonStructToUnion( const msg = if (field_count > 1) try sema.errMsg( block, inst_src, - "cannot initialize multiple union fields at once, unions can only have one active field", + "cannot initialize multiple union fields at once; unions can only have one active field", .{}, ) else try sema.errMsg( block, |