www.ziglang.org icon indicating copy to clipboard operation
www.ziglang.org copied to clipboard

Doc viewer broken for aliased types

Open bgourlie opened this issue 4 months ago • 4 comments

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.

bgourlie avatar Aug 21 '25 14:08 bgourlie

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.

nektro avatar Aug 21 '25 22:08 nektro

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

bgourlie avatar Aug 21 '25 22:08 bgourlie

the source code is listed as:

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

nektro avatar Aug 21 '25 22:08 nektro

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.

bgourlie avatar Aug 21 '25 22:08 bgourlie