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.

Sign up for GitHub

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

Jump to bottom

Move or introduce Zig Test earlier in language reference documentation #5837

Closed
paulespinosa opened this issue Jul 10, 2020 · 1 comment · Fixed by #9313
Closed

Move or introduce Zig Test earlier in language reference documentation #5837

paulespinosa opened this issue Jul 10, 2020 · 1 comment · Fixed by #9313
Labels
docs
Milestone
0.9.0

Comments

@paulespinosa
Copy link
Contributor

Issue

The Zig language reference (documentation) has many code samples implemented in tests (Zig's Test tool). However, the Zig Test tool is introduced and documented much later, further down, in the Zig documentation. New Zig users may not know about this section as they read the documentation and miss an opportunity to understand the syntax and tool.

Proposal

Two options:

  1. Move the Zig Test section before any usages of the Zig test tool.
  2. Before any usage of the Zig test tool, introduce the test syntax and basic usage of the Zig test tool and include a link to the Zig Test section.

Justification

Give new Zig learners the opportunity to understand the Zig Test tool before it is used in other code samples.
@Vexu Vexu added docs proposal This issue suggests modifications. If it also has the "accepted" label then it is planned. labels Jul 10, 2020
@Vexu Vexu added this to the 0.7.0 milestone Jul 10, 2020
@andrewrk andrewrk modified the milestones: 0.7.0, 0.8.0 Oct 13, 2020
@Mouvedia
Copy link

related: #8221

@andrewrk andrewrk modified the milestones: 0.8.0, 0.9.0 May 19, 2021
paulespinosa added a commit to paulespinosa/zig that referenced this issue Jul 6, 2021
@paulespinosa
Introduce Zig Test earlier in Language Reference
c750c04 
The "Zig Test" section of the language reference has been moved between the
current "Hello World" section and the "Comments" section. This was done to
introduce the Zig test syntax before it is used in later sections.

The description of the Zig test feature has NOT been updated in this commit.

Closes ziglang#5837
@paulespinosa paulespinosa mentioned this issue Jul 6, 2021
Merged
andrewrk pushed a commit that referenced this issue Jul 8, 2021
@paulespinosa @andrewrk
Introduce Zig Test earlier in Language Reference
a201d80 
The "Zig Test" section of the language reference has been moved between the
current "Hello World" section and the "Comments" section. This was done to
introduce the Zig test syntax before it is used in later sections.

The description of the Zig test feature has NOT been updated in this commit.

Closes #5837
@andrewrk andrewrk removed the proposal This issue suggests modifications. If it also has the "accepted" label then it is planned. label Jul 8, 2021
@paulespinosa paulespinosa mentioned this issue Sep 30, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
0.9.0
Development

Successfully merging a pull request may close this issue.

Move Zig Test earlier in Language Reference paulespinosa/zig
4 participants
@andrewrk @Mouvedia @paulespinosa @Vexu