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.

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
Closed

basic documentation for everything #367

andrewrk opened this issue May 8, 2017 · 7 comments

Comments

@andrewrk
Copy link
Member

@andrewrk 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 this to the 0.1.0 milestone May 8, 2017
@raulgrell
Copy link
Contributor

@raulgrell raulgrell commented May 8, 2017

Cracks knuckles

I got yo' back, son!

@tiehuis
Copy link
Member

@tiehuis 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
Copy link
Member Author

@andrewrk 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 removed this from the 0.1.0 milestone Oct 16, 2017
@andrewrk andrewrk added this to the 0.2.0 milestone Oct 16, 2017
andrewrk added a commit that referenced this issue Jan 23, 2018
 * 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 removed this from the 0.2.0 milestone Mar 12, 2018
@andrewrk andrewrk added this to the 0.3.0 milestone Mar 12, 2018
@andrewrk andrewrk mentioned this issue Mar 26, 2018
12 tasks
@0joshuaolson1
Copy link

@0joshuaolson1 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
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 14, 2018
andrewrk added a commit that referenced this issue Jun 18, 2018
@andrewrk andrewrk mentioned this issue Jul 11, 2018
8 tasks
@tiehuis tiehuis added the docs label Jul 23, 2018
@andrewrk andrewrk mentioned this issue Aug 25, 2018
21 tasks
@ghost
Copy link

@ghost ghost commented Sep 5, 2018


I'm really curious about the build system

👍

@andrewrk
Copy link
Member Author

@andrewrk 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
@ghost
Copy link

@ghost ghost 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
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants