diff --git a/doc/build.zig.zon.md b/doc/build.zig.zon.md index de5ec5fe9c..d0740a9237 100644 --- a/doc/build.zig.zon.md +++ b/doc/build.zig.zon.md @@ -12,6 +12,14 @@ build.zig. String. Required. +This is the default name used by packages depending on this one. For example, +when a user runs `zig fetch --save `, this field is used as the key in the +`dependencies` table. Although the user can choose a different name, most users +will stick with this provided value. + +It is redundant to include "zig" in this name because it is already within the +Zig package namespace. + ### `version` String. Required. diff --git a/lib/init/build.zig.zon b/lib/init/build.zig.zon index 0db17eaf9a..8684a901a9 100644 --- a/lib/init/build.zig.zon +++ b/lib/init/build.zig.zon @@ -1,5 +1,13 @@ .{ + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save `, this field is used + // as the key in the `dependencies` table. Although the user can choose a + // different name, most users will stick with this provided value. + // + // It is redundant to include "zig" in this name because it is already + // within the Zig package namespace. .name = "$", + // This is a [Semantic Version](https://semver.org/). // In a future version of Zig it will be used for package deduplication. .version = "0.0.0",