a/ziglings
1
0
Fork 0
mirror of https://codeberg.org/andyscott/ziglings.git synced 2024-12-22 14:03:10 -05:00
Code Issues Projects Releases Packages Wiki Activity

test: fix doc-comments

Browse source 
CheckStep, FailStep, fail, HealStep and heal incorrectly used a normal
comment, instead of a doc-comment.

Additionally, improve the documentation for FailStep and HealStep.
This commit is contained in:
Manlio Perillo 2023-05-04 18:48:35 +02:00
parent 5c488a1402
commit 277c95db7a
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
test/tests.zig
View file

@ -158,7 +158,7 @@ fn createCase(b: *Build, name: []const u8) *Step {
return case_step; return case_step;
} }
// Check the output of `zig build` or `zig build -Dn=1 start`. /// Checks the output of `zig build` or `zig build -Dn=1 start`.
const CheckStep = struct { const CheckStep = struct {
step: Step, step: Step,
exercises: []const Exercise, exercises: []const Exercise,
@ -282,7 +282,7 @@ const CheckStep = struct {
} }
}; };
// A step that will fail. /// Fails with a custom error message.
const FailStep = struct { const FailStep = struct {
step: Step, step: Step,
error_msg: []const u8, error_msg: []const u8,
@ -311,9 +311,9 @@ const FailStep = struct {
} }
}; };
// A variant of `std.Build.Step.fail` that does not return an error so that it /// A variant of `std.Build.Step.fail` that does not return an error so that it
// can be used in the configuration phase. It returns a FailStep, so that the /// can be used in the configuration phase. It returns a FailStep, so that the
// error will be cleanly handled by the build runner. /// error will be cleanly handled by the build runner.
fn fail(step: *Step, comptime format: []const u8, args: anytype) *Step { fn fail(step: *Step, comptime format: []const u8, args: anytype) *Step {
const b = step.owner; const b = step.owner;
@ -323,7 +323,7 @@ fn fail(step: *Step, comptime format: []const u8, args: anytype) *Step {
return step; return step;
} }
// A step that heals exercises. /// Heals the exercises.
const HealStep = struct { const HealStep = struct {
step: Step, step: Step,
exercises: []const Exercise, exercises: []const Exercise,
@ -353,7 +353,7 @@ const HealStep = struct {
} }
}; };
// Heals all the exercises. /// Heals all the exercises.
fn heal(allocator: Allocator, exercises: []const Exercise, work_path: []const u8) !void { fn heal(allocator: Allocator, exercises: []const Exercise, work_path: []const u8) !void {
const join = fs.path.join; const join = fs.path.join;