Skip to content

Commit 77e41cc

Browse files
committed
docs: add stub stdlib/memory, mark guide as done.
1 parent 751e0f4 commit 77e41cc

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

docs/guide.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Language guide
88

99
.. py:currentmodule:: amaranth.hdl
1010
11-
.. warning::
12-
13-
This guide is a work in progress and is seriously incomplete!
14-
1511
This guide introduces the Amaranth language in depth. It assumes familiarity with synchronous digital logic and the Python programming language, but does not require prior experience with any hardware description language. See the :doc:`tutorial <tutorial>` for a step-by-step introduction to the language, and the :doc:`reference <reference>` for a detailed description of the Python classes that underlie the language's syntax.
1612

1713
.. TODO: link to a good synchronous logic tutorial and a Python tutorial?
@@ -1606,7 +1602,7 @@ The renaming of the ``sync`` clock domain in it causes the behavior of the final
16061602
Memories
16071603
========
16081604

1609-
.. todo:: Write this section.
1605+
Amaranth provides support for memories in the standard library module :mod:`amaranth.lib.memory`.
16101606

16111607

16121608
.. _lang-instance:

docs/stdlib.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The Amaranth standard library is separate from the Amaranth language: everything
1717
stdlib/enum
1818
stdlib/data
1919
stdlib/wiring
20+
stdlib/memory
2021
stdlib/cdc
2122
stdlib/coding
2223
stdlib/fifo

docs/stdlib/memory.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Memories
2+
--------
3+
4+
.. py:module:: amaranth.lib.memory
5+
6+
The :mod:`amaranth.lib.memory` module provides a way to efficiently store data organized as an array of identically shaped rows, which may be addressed (read and/or written) one at a time.
7+
8+
.. todo::
9+
10+
Write the rest of this document.

0 commit comments

Comments
 (0)