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

basic documentation for everything #367

Closed
andrewrk opened this Issue May 8, 2017 · 7 comments

Comments

Projects
None yet
5 participants
@andrewrk
Member

andrewrk commented May 8, 2017

I started the effort here: http://ziglang.org/documentation/master/

If anyone wants to help you can submit a pull request to edit doc/langref.html.in. It's processed with doc/docgen.zig

@andrewrk andrewrk added the enhancement label May 8, 2017

@andrewrk andrewrk added this to the 0.1.0 milestone May 8, 2017

@raulgrell

This comment has been minimized.

Show comment
Hide comment
@raulgrell

raulgrell May 8, 2017

Contributor

Cracks knuckles

I got yo' back, son!

Contributor

raulgrell commented May 8, 2017

Cracks knuckles

I got yo' back, son!

@tiehuis

This comment has been minimized.

Show comment
Hide comment
@tiehuis

tiehuis Jul 4, 2017

Member

Just a note; I'm in the process of writing some documentation for the current TODO items. I'll save a pull-request and review until I have a fair few done, but will be periodically pushing here.

e.g. https://github.com/tiehuis/zig-notes/blob/master/enum.zig

Member

tiehuis commented Jul 4, 2017

Just a note; I'm in the process of writing some documentation for the current TODO items. I'll save a pull-request and review until I have a fair few done, but will be periodically pushing here.

e.g. https://github.com/tiehuis/zig-notes/blob/master/enum.zig

@andrewrk

This comment has been minimized.

Show comment
Hide comment
@andrewrk

andrewrk Aug 6, 2017

Member

TODO list:

  • "expression value is ignored"
  • explain why a << b b is the Log2 integer size
  • #375
  • Slices
  • Pointers
  • #307
  • unreachable
  • Errors
  • Nullables
  • alignment
  • bit fields
  • Casting
  • void
  • this - instead of documenting it we'll remove it. see #1283
  • comptime
  • Assembly
  • Atomics
  • is <<% even "wrapping" around? or is it just truncating? maybe it shouldn't be one of the % operators?
  • #372
  • undefined behavior for exact division remainder
  • undefined behavior for slice widen remainder
  • undefined behavior for invalid enum cast
  • Root Source File
  • Zig Test
  • Zig Build System
  • a more complex @cInclude example that has multiple includes and demonstrates compile time control flow and @cDefine, @cUndef, etc.
  • move to ziglang.org/documentation/master/index.html to make room for ziglang.org/documentation/0.1.0/index.html
  • move docs to zig repo
  • async/await/coroutines
  • add || to operator list and precedence section
  • setting the section on global variables and functions
  • labeled break and continue
  • noalias
  • extern struct
  • labeled blocks and loops
  • clarify that @setFloatMode is inherited by blocks
Member

andrewrk commented Aug 6, 2017

TODO list:

  • "expression value is ignored"
  • explain why a << b b is the Log2 integer size
  • #375
  • Slices
  • Pointers
  • #307
  • unreachable
  • Errors
  • Nullables
  • alignment
  • bit fields
  • Casting
  • void
  • this - instead of documenting it we'll remove it. see #1283
  • comptime
  • Assembly
  • Atomics
  • is <<% even "wrapping" around? or is it just truncating? maybe it shouldn't be one of the % operators?
  • #372
  • undefined behavior for exact division remainder
  • undefined behavior for slice widen remainder
  • undefined behavior for invalid enum cast
  • Root Source File
  • Zig Test
  • Zig Build System
  • a more complex @cInclude example that has multiple includes and demonstrates compile time control flow and @cDefine, @cUndef, etc.
  • move to ziglang.org/documentation/master/index.html to make room for ziglang.org/documentation/0.1.0/index.html
  • move docs to zig repo
  • async/await/coroutines
  • add || to operator list and precedence section
  • setting the section on global variables and functions
  • labeled break and continue
  • noalias
  • extern struct
  • labeled blocks and loops
  • clarify that @setFloatMode is inherited by blocks

@andrewrk andrewrk modified the milestones: 0.1.0, 0.2.0 Oct 16, 2017

andrewrk added a commit that referenced this issue Jan 23, 2018

add new kind of test: generating .h files. and more
 * docgen supports obj_err code kind for demonstrating
   errors without explicit test cases
 * add documentation for `extern enum`. See #367
 * remove coldcc keyword and add @setIsCold. See #661
 * add compile errors for non-extern struct, enum, unions
   in function signatures
 * add .h file generation for extern struct, enum, unions

@andrewrk andrewrk modified the milestones: 0.2.0, 0.3.0 Mar 12, 2018

@andrewrk andrewrk referenced this issue Mar 26, 2018

Closed

zig build system #204

8 of 12 tasks complete
@0joshuaolson1

This comment has been minimized.

Show comment
Hide comment
@0joshuaolson1

0joshuaolson1 May 25, 2018

Contributor

I'm really curious about the build system (e.g. to see how it compares in maturity/scope with a wannabe cmake killer I'm following). Is the code the best docs (and where?), or has some contributor somewhere started on it?

Is deterministic package management in scope? Maybe the docs could link to umbrella/section-specific issues about their future plans?

Contributor

0joshuaolson1 commented May 25, 2018

I'm really curious about the build system (e.g. to see how it compares in maturity/scope with a wannabe cmake killer I'm following). Is the code the best docs (and where?), or has some contributor somewhere started on it?

Is deterministic package management in scope? Maybe the docs could link to umbrella/section-specific issues about their future plans?

andrewrk added a commit that referenced this issue Jun 7, 2018

langref: automatic update of builtin.zig
now the docs can't get out of date for this

See #367

andrewrk added a commit that referenced this issue Jun 11, 2018

andrewrk added a commit that referenced this issue Jun 12, 2018

andrewrk added a commit that referenced this issue Jun 14, 2018

andrewrk added a commit that referenced this issue Jun 18, 2018

andrewrk added a commit that referenced this issue Jul 2, 2018

@andrewrk andrewrk referenced this issue Jul 11, 2018

Closed

solve concurrency #174

6 of 8 tasks complete

@tiehuis tiehuis added the docs label Jul 23, 2018

@andrewrk andrewrk referenced this issue Aug 25, 2018

Closed

Tracker: Documentation #1366

0 of 21 tasks complete
@monouser7dig

This comment has been minimized.

Show comment
Hide comment
@monouser7dig

monouser7dig Sep 5, 2018


I'm really curious about the build system

👍

monouser7dig commented Sep 5, 2018


I'm really curious about the build system

👍

@andrewrk

This comment has been minimized.

Show comment
Hide comment
@andrewrk

andrewrk Sep 13, 2018

Member

I broke this issue up into independent issues that each have more details.

Member

andrewrk commented Sep 13, 2018

I broke this issue up into independent issues that each have more details.

@andrewrk andrewrk closed this Sep 13, 2018

@monouser7dig

This comment has been minimized.

Show comment
Hide comment
@monouser7dig

monouser7dig Sep 13, 2018

👍 for 0.4 looking very usable

monouser7dig commented Sep 13, 2018

👍 for 0.4 looking very usable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment