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

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
Labels
docs enhancement Solving this issue will likely involve adding new logic or components to the codebase.
Milestone
0.3.0

Comments

@andrewrk
Copy link
Member

andrewrk commented May 8, 2017 •
edited
Loading

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 Solving this issue will likely involve adding new logic or components to the codebase. label May 8, 2017
@andrewrk andrewrk added this to the 0.1.0 milestone May 8, 2017
@raulgrell
Copy link
Contributor

Cracks knuckles

I got yo' back, son!

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

andrewrk commented Aug 6, 2017 •
edited
Loading

TODO list:

  • "expression value is ignored"
  • explain why a << b b is the Log2 integer size
  • add to standard library: parse floats #375
  • Slices
  • Pointers
  • wrong order of bits in bit fields #307
  • unreachable
  • Errors
  • Nullables
  • alignment
  • bit fields
  • Casting
  • void
  • this - instead of documenting it we'll remove it. see remove this #1283
  • comptime
  • Assembly
  • Atomics
  • is <<% even "wrapping" around? or is it just truncating? maybe it shouldn't be one of the % operators?
  • add compile error for division by zero #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 mentioned this issue Aug 7, 2017
Closed
@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
@andrewrk
add new kind of test: generating .h files. and more
cf39819 
 * 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 mentioned this issue Mar 18, 2018
Closed
@andrewrk andrewrk mentioned this issue Mar 26, 2018
Closed
12 tasks
@andrewrk andrewrk mentioned this issue May 4, 2018
Closed
@0joshuaolson1
Copy link

0joshuaolson1 commented May 25, 2018 •
edited
Loading

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 andrewrk mentioned this issue Jun 2, 2018
Closed
andrewrk added a commit that referenced this issue Jun 7, 2018
@andrewrk
langref: automatic update of builtin.zig
688ff28 
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
langref: add coroutines documentation
5252566 
See #367
andrewrk added a commit that referenced this issue Jun 12, 2018
@andrewrk
add docs and missing test case for merging error sets
86adc1e 
See #367
andrewrk added a commit that referenced this issue Jun 14, 2018
@andrewrk
langref: docs for error return traces
f0697c2 
See #367
andrewrk added a commit that referenced this issue Jun 18, 2018
@andrewrk
langref: add docs for void
48985a7 
see #367
andrewrk added a commit that referenced this issue Jul 2, 2018
@andrewrk
add runtime safety for @intToEnum; add docs for runtime safety
3546352 
See #367
@andrewrk andrewrk mentioned this issue Jul 11, 2018
Closed
8 tasks
@tiehuis tiehuis added the docs label Jul 23, 2018
@andrewrk andrewrk mentioned this issue Aug 25, 2018
Closed
21 tasks
@ghost
Copy link

ghost commented Sep 5, 2018 •
edited by andrewrk
Loading

I'm really curious about the build system

👍

This was referenced Sep 13, 2018
Closed
Closed
Closed
Open
This was referenced Sep 13, 2018
Open
Closed
Open
Closed
Open
Closed
Open
andrewrk added a commit that referenced this issue Sep 13, 2018
@andrewrk
remove the scope parameter of setFloatMode
7c3636a 
also document that scopes inherit this value. See #367
See #1283
@andrewrk
Copy link
Member Author

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

@ghost
Copy link

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
Assignees
No one assigned
Labels
docs enhancement Solving this issue will likely involve adding new logic or components to the codebase.
Projects
None yet
Milestone
0.3.0
Development

No branches or pull requests
4 participants
@andrewrk @raulgrell @0joshuaolson1 @tiehuis