usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs/stdlib: write an introductory section.

Browse source 
Co-authored-by: Wanda <wanda-phi@users.noreply.github.com>
Co-authored-by: mcclure <mcclure@users.noreply.github.com>
This commit is contained in:
Catherine 2023-11-26 03:39:26 +00:00
parent a2aa07cbc7
commit fc4d70486a
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/stdlib.rst
View file

@ -1,9 +1,13 @@
Standard library Standard library
################ ################
.. todo:: The :mod:`amaranth.lib` module, also known as the standard library, provides modules that falls into one of the three categories:
Write this section. 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).
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.cdc`.
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`.
The Amaranth standard library is separate from the Amaranth language: everything provided in it could have been implemented in a third-party library.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -11,7 +15,7 @@ Standard library
stdlib/enum stdlib/enum
stdlib/data stdlib/data
stdlib/wiring stdlib/wiring
stdlib/coding
stdlib/cdc stdlib/cdc
stdlib/crc stdlib/coding
stdlib/fifo stdlib/fifo
stdlib/crc