-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Description
Zig Version
0.12.0-dev.1+a327d8b99
Steps to Reproduce and Observed Behavior
- Navigate to std.Build documentation
- Click on any link to "LazyPath"
- It takes you to https://ziglang.org/documentation/master/std/#A;std:Build.FileSource, the page title is
std.Build.FileSource, but all the comments on the page refer to it as LazyPath.
The same exists for:
- Step.Compile: goes to std.Build.LibExeObjStep.
- Build: goes to std.Build.Builder
Expected Behavior
LazyPath links should go to https://ziglang.org/documentation/master/std/#A;std:Build.LazyPath
and Step.Compile to https://ziglang.org/documentation/master/std/#A;std:Build.Step.Compile.
Build links should go back to std.Build.
This is likely caused by declaration positions:
-
FileSource is defined earlier in Build.zig than LazyPath:
Line 61 in ac95cfe
pub const FileSource = LazyPath; Line 1672 in ac95cfe
pub const LazyPath = union(enum) { -
LibExeObjStep is defined earlier than Step:
Line 25 in ac95cfe
pub const LibExeObjStep = Step.Compile; Line 31 in ac95cfe
pub const Step = @import("Build/Step.zig");
Note that other deprecations where the new entity is defined before the deprecated do not suffer from this. For example, other types nested inside Step defined after it do not have this problem:
Lines 32 to 35 in ac95cfe
| /// deprecated: use `Step.CheckFile`. | |
| pub const CheckFileStep = @import("Build/Step/CheckFile.zig"); | |
| /// deprecated: use `Step.CheckObject`. | |
| pub const CheckObjectStep = @import("Build/Step/CheckObject.zig"); |
Step.CheckFile links go to the right link.