Skip to content

Commit cd51e02

Browse files
wanda-phiwhitequark
authored andcommitted
lib.wiring: remove stray references to signature freezing.
1 parent efcd9a4 commit cd51e02

File tree

1 file changed

+3
-12
lines changed

1 file changed

+3
-12
lines changed

amaranth/lib/wiring.py

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -324,14 +324,11 @@ def __repr__(self):
324324
class SignatureError(Exception):
325325
"""
326326
This exception is raised when an invalid operation specific to signature manipulation is
327-
performed with :class:`SignatureMembers`, such as adding a member to a frozen signature.
328-
Other exceptions, such as :exc:`TypeError` or :exc:`NameError`, will still be raised where
329-
appropriate.
327+
performed with :class:`SignatureMembers`. Other exceptions, such as :exc:`TypeError` or
328+
:exc:`NameError`, will still be raised where appropriate.
330329
"""
331330

332331

333-
# Inherits from Mapping and not MutableMapping because it's only mutable in a very limited way
334-
# and most of the methods (except for `update`) added by MutableMapping are useless.
335332
@final
336333
class SignatureMembers(Mapping):
337334
"""Mapping of signature member names to their descriptions.
@@ -340,13 +337,7 @@ class SignatureMembers(Mapping):
340337
attribute of signature objects.
341338
342339
The keys in this container must be valid Python attribute names that are public (do not begin
343-
with an underscore. The values must be instances of :class:`Member`. The container is mutable
344-
in a restricted manner: new keys may be added, but existing keys may not be modified or removed.
345-
In addition, the container can be `frozen`, which disallows addition of new keys. Freezing
346-
a container recursively freezes the members of any signatures inside.
347-
348-
In addition to the use of the superscript operator, multiple members can be added at once with
349-
the :py:`+=` opreator.
340+
with an underscore. The values must be instances of :class:`Member`. The container is immutable.
350341
351342
The :meth:`create` method converts this mapping into a mapping of names to signature members
352343
(signals and interface objects) by creating them from their descriptions. The created mapping

0 commit comments

Comments
 (0)