Skip to content

docs: minor fixes to main language reference page. #25903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: minor fixes to main language reference page. #25903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e486d0
docs: remove normal-doc comment interleaving bug note.
aznashwan Nov 11, 2025
23707ba
docs: clarify values.zig error name is arbitrary.
aznashwan Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/langref.html.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,8 +421,7 @@
{#code|unattached_doc-comment.zig#}

<p>
Doc comments can be interleaved with normal comments. Currently, when producing
the package documentation, normal comments are merged with doc comments.
Doc comments can be interleaved with normal comments, which are ignored.
</p>
{#header_close#}
{#header_open|Top-Level Doc Comments#}
Expand Down
2 changes: 1 addition & 1 deletion doc/langref/values.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub fn main() void {
});

// error union
var number_or_error: anyerror!i32 = error.ArgNotFound;
var number_or_error: anyerror!i32 = error.ArbitraryErrorName;

print("\nerror union 1\ntype: {}\nvalue: {!}\n", .{
@TypeOf(number_or_error),
Expand Down