Commit Graph

888 Commits

Author SHA1 Message Date
Andrew Kelley
1b90888f57 migrate langref documentation generation to the build system 2024-04-25 00:09:24 -07:00
Andrew Kelley
a685ab1499 Release 0.12.0 2024-04-19 14:00:35 -07:00
Nguyễn Gia Phong
5b9579845d Document packed struct's backing int declaration 2024-04-11 14:45:28 -07:00
Andrew Kelley
c78f996ff9 langref: update async functions section 2024-04-07 14:13:03 -07:00
Alex
b22ef55f36 langref: Fix example typo 2024-04-06 10:01:42 +03:00
Nguyễn Gia Phong
5835e5ec9a grammar: fix ASCII range typo 2024-04-02 13:46:11 -07:00
Jacob Young
eb723a4070 Update uses of @fieldParentPtr to use RLS 2024-03-30 20:50:48 -04:00
Andrew Kelley
fb812fc1fc langref: add naming guide 2024-03-18 23:52:52 -07:00
Linus Groh
d100a8e2dc langref: Rename std.fs.wasi.{PreopenList => Preopens} 2024-03-19 07:22:50 +02:00
Jacob Young
d10c52c194 AstGen: disallow alignment on function types
A pointer type already has an alignment, so this information does not
need to be duplicated on the function type.  This already has precedence
with addrspace which is already disallowed on function types for this
reason.  Also fixes `@TypeOf(&func)` to have the correct addrspace and
alignment.
2024-03-17 03:06:17 +01:00
Andrew Kelley
cb419a1a86 langref: caution against default field values
closes #19169
2024-03-15 16:37:13 -07:00
Paul Jimenez
df174648e4
langref: bit-aligned -> byte-aligned 2024-03-15 16:40:03 +02:00
mlugg
5193da3422 langref: add basic documentation of RLS 2024-03-15 03:10:45 +00:00
Tristan Ross
c260b4c753
std.builtin: make global linkage fields lowercase 2024-03-11 07:09:10 -07:00
Tristan Ross
aab84a3dec
std.builtin: make float mode fields lowercase 2024-03-11 07:09:10 -07:00
Jacob Young
aa7d16aba1 grammar: remove gratuitous ambiguity
Previously, the following matched both ContainerField alternatives:
 * [IDENTIFIER]
 * [IDENTIFIER][COLON][TypeExpr]
2024-03-06 13:59:46 -08:00
crayon
f5e2fa5c95 langref now sets color-scheme 2024-03-05 15:55:00 +02:00
Michael Ortmann
0b744da844 Fix doc - Language Reference - Table of Operators 2024-03-04 15:59:00 +00:00
Jacob Young
d656c2a7ab test: rework how filtering works
* make test names contain the fully qualified name
 * make test filters match the fully qualified name
 * allow multiple test filters, where a test is skipped if it does not
   match any of the specified filters
2024-02-25 19:12:08 -08:00
Andrew Kelley
54bbc73f85
Merge pull request #18712 from Vexu/std.options
std: make options a struct instance instead of a namespace
2024-02-09 13:38:42 -08:00
iwVerve
7bd8b35a3d langref: fix missing word typo 2024-02-06 17:22:59 +02:00
Veikka Tuominen
318e9cdaaa langref: fix error set order
Something about the stdlib changes swapped the order?
2024-02-01 15:22:36 +02:00
Andrew Kelley
ce7c66e2d0 langref: make more consistent
* moves some langref into std.builtin doc comments
* use the same way of referencing stuff from std.builtin

closes #16483
2024-01-21 20:39:50 -07:00
Andrew Kelley
1b8e6b8ba9 langref: clean up the table of operators
* remove whitespace
* add column for name
* rename "description" to "remarks"
* clarify bit shift left and bit shift right

closes #17126
2024-01-21 20:31:13 -07:00
Andrew Kelley
f29217ae0c langref: reduce verbosity of string literal section 2024-01-21 20:31:13 -07:00
Andrew Kelley
9be831e15a langref: remove line numbers from code samples
It's unnecessary, more complicated, bloated, and it messes up the table
of operators.
2024-01-21 20:31:13 -07:00
Andrew Kelley
a054c01f5c Revert "langref: add section numbers"
This reverts commit 3542dbf0ea.

I don't like them
2024-01-21 20:31:13 -07:00
Andrew Kelley
e9c7ebe79e langref: simplify Hello World section
reverts f510f38592
2024-01-21 20:31:13 -07:00
Andrew Kelley
6fef362992 Revert "langref: emphasize the use of dereferencing string literals"
This reverts commit 27353bb936.

* unnecessary example
* poor phrasing (avoid "you")
2024-01-21 20:31:13 -07:00
Andrew Kelley
559bbf1cc6 langref: explicitly mention inline combined with multiple cases
closes #18524
2024-01-21 20:31:13 -07:00
Ian Johnson
fdb4eb3056 langref: add information about doctests
This creates a section in the language reference about doctests, which
is currently referenced by Autodoc in a tooltip when displaying a
doctest.

Some advice relevant to writing doctests is included, based on the
discussion on #16472.
2024-01-21 19:28:52 -08:00
Andrew Kelley
96e54e7017 langref: extract code comments into paragraphs
Related #18496
2024-01-18 22:01:09 -07:00
Andrew Kelley
56db624643 langref: update Zig Build System section
It's hosted externally for now.

closes #18103
2024-01-18 22:01:09 -07:00
Andrew Kelley
8662c0ff43 langref: avoid the ambiguous word "safe"
See #2402
2024-01-18 22:01:09 -07:00
Andrew Kelley
9e6ff71330 langref: delete Nested Container Tests section
This section documented how a buggy feature worked at one point in time
but it's not a description of what is supposed to happen. What is
supposed to happen is simple enough to not warrant any documentation
about it. When a file is imported, all the test decls are supposed to be
queued for analysis.

Also, refAllDecls() is a hack which should not be celebrated or even
mentioned in the language reference.

closes #18042
2024-01-18 22:01:09 -07:00
Andrew Kelley
9b714e019c
Merge pull request #18219 from g-cassie/optional-documentation-tweaks
Minor improvements to the Optionals documentation
2024-01-18 20:34:00 -08:00
Piotr Szlachciak
c724cc6487 Move the paragraph to under variables 2024-01-16 20:18:45 +02:00
Piotr Szlachciak
2d4ebcffbf Move the extern paragraph to a more logical place 2024-01-16 20:18:45 +02:00
Piotr Szlachciak
6a3f9a0b50 Add missing != null operator 2024-01-16 20:17:29 +02:00
emberfade
c2659e0371 langref: Fix example for Generic Data Structures 2024-01-13 23:13:44 -08:00
Andrew Kelley
63de8a5989 langref: fix typo 2024-01-11 01:02:21 -08:00
Andrew Kelley
aba8d4f62c langref: document inline functions 2024-01-10 19:31:45 -07:00
dweiller
8695bc7ed3 langref: mention error union switch peer resolution 2024-01-09 14:42:12 +11:00
Andrew Kelley
8c9efc95a1 langref: update target section
* remove outdated information
* add new information

closes #17032
closes #17044
2024-01-08 18:48:10 -07:00
Scott Schwarz
f5978181e4
langref: reword Hello World section (#18458)
closes #14347
2024-01-08 01:32:26 -05:00
Andrew Kelley
52ebba6bdf @shlExact fixups
* Add clarification in langref
* move test case to behavior tests
2024-01-04 00:44:44 -07:00
Samuel Nevarez
25a556107c langref: order comment to align with code example 2024-01-02 12:06:59 +02:00
Gordon Cassie
ef93a36cd5 Add comment. Split up if docs for optionals. 2023-12-07 13:51:03 -08:00
Gordon Cassie
cce820f93d Add cross references for optional documentation and another example of optional capture in while loop. 2023-12-07 10:53:05 -08:00
Nan Zhong
72568c131d langref: fix incorrect reference to string literal 2023-12-05 10:17:36 +02:00