Skip to content
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.

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

autodoc: std.crypto.aead.aes_gcm.Aes256Gcm has the wrong url #22195

Open
nektro opened this issue Dec 9, 2024 · 4 comments
Open

autodoc: std.crypto.aead.aes_gcm.Aes256Gcm has the wrong url #22195

nektro opened this issue Dec 9, 2024 · 4 comments
Labels
bug Observed behavior contradicts documented or intended behavior

Comments

@nektro
Copy link
Contributor

nektro commented Dec 9, 2024

Zig Version

0.14.0-dev.2415+e62aac3ec

Steps to Reproduce and Observed Behavior

Expected Behavior

@nektro nektro added the bug Observed behavior contradicts documented or intended behavior label Dec 9, 2024
@rohlem
Copy link
Contributor

rohlem commented Dec 9, 2024

It might be of note that aes_gcm exists both with and without aead prefix (https://ziglang.org/documentation/master/std/#std.crypto.aead.aes_gcm vs https://ziglang.org/documentation/master/std/#std.crypto.aes_gcm).

@nektro
Copy link
Contributor Author

nektro commented Dec 9, 2024

that doesn't reflect https://github.com/ziglang/zig/blob/master/lib/std/crypto.zig
nor https://ziglang.org/documentation/master/std/#std.crypto
but does highlight that the other subnamespaces are affected as well
eg https://ziglang.org/documentation/master/std/#std.crypto.aegis (should be std.crypto.auth.aegis

@ianprime0509
Copy link
Contributor

This is the same underlying behavior as in #19262: the URL hash std.crypto.aes_gcm.Aes256Gcm reflects the path to the source file (std/crypto/aes_gcm.zig + Aes256Gcm). However, as @rohlem noted, it is also possible to navigate using the namespace path, it just isn't the canonical path you get from navigation.

@nektro
Copy link
Contributor Author

nektro commented Dec 10, 2024

unfortunate,
that makes sense, but i think that's very unintuitive for users with the separator being a . instead of /

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Observed behavior contradicts documented or intended behavior
Projects
None yet
Development

No branches or pull requests

3 participants