Skip to content

Commit fc4d704

Browse files
whitequarkwanda-phimcclure
committed
docs/stdlib: write an introductory section.
Co-authored-by: Wanda <wanda-phi@users.noreply.github.com> Co-authored-by: mcclure <mcclure@users.noreply.github.com>
1 parent a2aa07c commit fc4d704

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/stdlib.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
Standard library
22
################
33

4-
.. todo::
4+
The :mod:`amaranth.lib` module, also known as the standard library, provides modules that falls into one of the three categories:
55

6-
Write this section.
6+
1. Modules that will used by essentially all idiomatic Amaranth code, and are necessary for interoperability. This includes :mod:`amaranth.lib.enum` (enumerations), :mod:`amaranth.lib.data` (data structures), and :mod:`amaranth.lib.wiring` (interfaces and components).
7+
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.cdc`.
8+
3. Modules that have essentially one correct implementation and are of broad utility in digital designs. This includes :mod:`amaranth.lib.coding`, :mod:`amaranth.lib.fifo`, and :mod:`amaranth.lib.crc`.
9+
10+
The Amaranth standard library is separate from the Amaranth language: everything provided in it could have been implemented in a third-party library.
711

812
.. toctree::
913
:maxdepth: 2
1014

1115
stdlib/enum
1216
stdlib/data
1317
stdlib/wiring
14-
stdlib/coding
1518
stdlib/cdc
16-
stdlib/crc
19+
stdlib/coding
1720
stdlib/fifo
21+
stdlib/crc

0 commit comments

Comments
 (0)