ziglang/ziglang.org
14
29
Fork
You've already forked ziglang.org
31

Doc viewer broken for aliased types #523

Open
opened 2025年08月21日 16:39:59 +02:00 by bgourlie · 4 comments
bgourlie commented 2025年08月21日 16:39:59 +02:00 (Migrated from github.com)
Copy link

See https://ziglang.org/documentation/master/std/#std.ArrayList

No useful documentation is shown. When you click to view the source, it navigates to the file where the alias is declared.

See https://ziglang.org/documentation/master/std/#std.ArrayList No useful documentation is shown. When you click to view the source, it navigates to the file where the alias is declared.
nektro commented 2025年08月22日 00:22:47 +02:00 (Migrated from github.com)
Copy link

it is not an alias. Source Code header shows source for just the decl that's active and [src] at the top shows the whole file it's contained in.

it is not an alias. `Source Code` header shows source for just the decl that's active and `[src]` at the top shows the whole file it's contained in.
bgourlie commented 2025年08月22日 00:25:17 +02:00 (Migrated from github.com)
Copy link

Are you saying this is expected? How do I view the documentation for ArrayList?

Are you saying this is expected? How do I view the documentation for ArrayList?
nektro commented 2025年08月22日 00:33:42 +02:00 (Migrated from github.com)
Copy link

the source code is listed as:

pubfnArrayList(comptimeT:type)type{returnarray_list.Aligned(T,null);}

so https://ziglang.org/documentation/master/std/#std.array_list.Aligned will be the page you're expecting

the source code is listed as: ```zig pub fn ArrayList(comptime T: type) type { return array_list.Aligned(T, null); } ``` so https://ziglang.org/documentation/master/std/#std.array_list.Aligned will be the page you're expecting
bgourlie commented 2025年08月22日 00:41:59 +02:00 (Migrated from github.com)
Copy link

Well what I'm expecting is to be able to search for the name of the type that I'm actually importing (std.ArrayList in this case) and be shown useful documentation. I think that seems like a reasonable expectation but if this is expected behavior feel free to close this issue.

Well what I'm expecting is to be able to search for the name of the type that I'm actually importing (std.ArrayList in this case) and be shown useful documentation. I think that seems like a reasonable expectation but if this is expected behavior feel free to close this issue.
Sign in to join this conversation.
No Branch/Tag specified
main
release-0.16.0
apraga/french
homersimpsons/fix/mobile-responsiveness
MarkLagodych/patch-1
Zirunis/patch-1
zmitchell/zmitchell/build-graph-docs
generalmimon/fix-unit-testing-examples
generalmimon/fix-code-snippet-in-0.15.1-relnotes
TheConnorJohnson/main
meeting-minutes
enkvadrat/update-curl-example
No results found.
Labels
Clear labels
bounty
https://ziglang.org/news/announcing-donor-bounties
bug
Observed behavior contradicts documented or intended behavior.
contributor-friendly
This issue is limited in scope and/or knowledge of project internals.
downstream
An issue with a third-party project that uses this project.
enhancement
Solving this issue will likely involve adding new logic or components to the codebase.
infra
An issue related to project infrastructure, e.g. continuous integration.
optimization
A task to improve performance and/or resource usage.
question
No questions on the issue tracker; use a community space instead.
regression
Something that used to work in a previous version stopped working
upstream
An issue with a third-party project that this project uses.
use case
Describes a real use case that is difficult or impossible, but does not propose a solution.
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ziglang/ziglang.org#523
Reference in a new issue
ziglang/ziglang.org
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?