Skip to content

Commit 6d7b17e

Browse files
wanda-phiwhitequark
authored andcommitted
Implement RFC 63: Remove amaranth.lib.coding.
1 parent 362b450 commit 6d7b17e

File tree

5 files changed

+14
-349
lines changed

5 files changed

+14
-349
lines changed

amaranth/lib/coding.py

-192
This file was deleted.

docs/changes.rst

+13
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Documentation for past releases
99

1010
Documentation for past releases of the Amaranth language and toolchain is available online:
1111

12+
* `Amaranth 0.5.0 <https://amaranth-lang.org/docs/amaranth/v0.5.0/>`_
1213
* `Amaranth 0.4.5 <https://amaranth-lang.org/docs/amaranth/v0.4.5/>`_
1314
* `Amaranth 0.4.4 <https://amaranth-lang.org/docs/amaranth/v0.4.4/>`_
1415
* `Amaranth 0.4.3 <https://amaranth-lang.org/docs/amaranth/v0.4.3/>`_
@@ -18,6 +19,18 @@ Documentation for past releases of the Amaranth language and toolchain is availa
1819
* `Amaranth 0.3 <https://amaranth-lang.org/docs/amaranth/v0.3/>`_
1920

2021

22+
Version 0.6 (unreleased)
23+
========================
24+
25+
26+
Standard library changes
27+
------------------------
28+
29+
.. currentmodule:: amaranth.lib
30+
31+
* Removed: (deprecated in 0.5) :mod:`amaranth.lib.coding`. (`RFC 63`_)
32+
33+
2134
Version 0.5
2235
===========
2336

docs/stdlib.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The :mod:`amaranth.lib` module, also known as the standard library, provides mod
55

66
1. Modules that will used by essentially all idiomatic Amaranth code, or which are necessary for interoperability. This includes :mod:`amaranth.lib.enum` (enumerations), :mod:`amaranth.lib.data` (data structures), :mod:`amaranth.lib.wiring` (interfaces and components), :mod:`amaranth.lib.meta` (interface metadata), and :mod:`amaranth.lib.stream` (data streams).
77
2. Modules that abstract common functionality whose implementation differs between hardware platforms. This includes :mod:`amaranth.lib.memory` and :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`.
8+
3. Modules that have essentially one correct implementation and are of broad utility in digital designs. This includes :mod:`amaranth.lib.fifo`, and :mod:`amaranth.lib.crc`.
99

1010
As part of the Amaranth backwards compatibility guarantee, any behaviors described in these documents will not change from a version to another without at least one version including a warning about the impending change. Any nontrivial change to these behaviors must also go through the public review as a part of the `Amaranth Request for Comments process <https://amaranth-lang.org/rfcs/>`_.
1111

@@ -22,6 +22,5 @@ The Amaranth standard library is separate from the Amaranth language: everything
2222
stdlib/memory
2323
stdlib/io
2424
stdlib/cdc
25-
stdlib/coding
2625
stdlib/fifo
2726
stdlib/crc

docs/stdlib/coding.rst

-27
This file was deleted.

tests/test_lib_coding.py

-128
This file was deleted.

0 commit comments

Comments
 (0)