Catherine
324c37f9fa
docs/stdlib/io: document I/O buffer library.
2024-05-21 15:58:59 +00:00
Catherine
ae71cf6601
docs/guide: remove the warning for array resource exhaustion.
...
It is no longer relevant in a NIR world.
2024-05-13 02:39:40 +00:00
Catherine
001f7c78dc
docs: note that Array and ArrayLayout are distinct.
2024-05-13 02:39:40 +00:00
Wanda
a7a7d32099
hdl._ast: deprecate Value.implies.
2024-04-16 19:26:08 +00:00
Chris Baker
c4370efcf4
docs: change combinatorial to combinational
...
- Replace occurrences of combinatorial with combinational in docstrings
- Replace occurrences of combinatorial with combinational in .rst files
- Add note to contrib.rst to document the editorial decision from #1301
2024-04-16 02:19:10 +00:00
Wanda
08aaac9a41
docs/guide: remove warning about lack of combinational loop detection.
2024-04-15 17:33:27 +00:00
Catherine
8c1c9f2d26
docs: begin building the documentation style guide.
2024-04-13 20:56:55 +00:00
Catherine
967dabc2fe
docs/{guide,reference}: clarify semantics of a.any() vs a.bool().
2024-04-03 13:29:19 +00:00
Catherine
f261071f7c
docs/guide: clarify section on IOBufferInstance.
...
There is no reason to assign names to `IOBufferInstance` submodules
because it's ignored anyways.
2024-03-26 23:21:29 +00:00
Wanda
744576011f
Implement RFC 53: Low-level I/O primitives.
...
Co-authored-by: Catherine <whitequark@whitequark.org>
Co-authored-by: mcclure <mcclure@users.noreply.github.com>
2024-03-18 20:33:22 +00:00
Catherine
add7d70050
docs/guide: fix incorrect reference.
2024-03-14 06:10:14 +00:00
Wanda
bfe541a6d7
Implement RFC 50: Print and string formatting.
...
Co-authored-by: Catherine <whitequark@whitequark.org>
2024-03-11 09:42:43 +00:00
Catherine
6dc7c2718c
docs/guide: fix a bunch of TODOs.
2024-02-27 09:10:29 +00:00
Catherine
77e41cc88a
docs: add stub stdlib/memory, mark guide as done.
2024-02-27 09:10:29 +00:00
Wanda
24a392887a
Implement RFC 43: Rename reset= to init=.
2024-02-15 22:52:24 +00:00
Catherine
b9c9948038
docs: use :py: role for inline Python code, not :pc:.
...
I originally picked :pc: as it is short for "python code", but it is
obscure and :py: is not taken, so a much more obvious role can be used
instead. Also, we all typo :pc: as :py: all the time anyway.
2024-02-13 10:38:36 +00:00
Wanda
5797643c9c
docs: remove leftover TODO and warning from #1003 , fix matches docs.
2024-02-13 06:23:23 +00:00
Catherine
0056e982c5
docs/reference: document Value, ValueCastable, ValueLike.
...
Co-authored-by: Wanda <wanda@phinode.net>
Co-authored-by: mcclure <mcclure@users.noreply.github.com>
2024-02-13 03:22:04 +00:00
Catherine
ea3d6c9557
docs/reference: document compat guarantee, importing, shapes.
...
This commit also contains a related semantic change: it adds `Shape`
and `ShapeCastable` to the `__all__` list in `amaranth.hdl`. This is
consistent with the policy that is laid out in the new documentation,
which permits such additions without notice.
Co-authored-by: mcclure <mcclure@users.noreply.github.com>
2024-01-30 22:54:18 +00:00
Catherine
c9b87a4fc5
docs: lang.rst→guide.rst, add reference.rst.
2024-01-30 22:54:18 +00:00
