Skip to content

Commit 5b42f02

Browse files
committed
Enable doctest, improve type annotations and documentation in helperfuncs.py. Also:
* Simplify some examples to make them testable, and fix some incorrect examples. * Discourage use of `input_list`, `output_list`, `register_list`, and `wirevector_list`. They've been removed from the documentation. List comprehensions are easier to read and don't expand the API.
1 parent 9ec718f commit 5b42f02

File tree

3 files changed

+365
-270
lines changed

3 files changed

+365
-270
lines changed

docs/helpers.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,6 @@ Control Flow Hardware
4646
:undoc-members:
4747
.. autofunction:: pyrtl.helperfuncs.match_bitpattern
4848

49-
Creating Lists of WireVectors
50-
-----------------------------
51-
52-
.. autofunction:: pyrtl.helperfuncs.input_list
53-
.. autofunction:: pyrtl.helperfuncs.output_list
54-
.. autofunction:: pyrtl.helperfuncs.register_list
55-
.. autofunction:: pyrtl.helperfuncs.wirevector_list
56-
5749
Interpreting Vectors of Bits
5850
----------------------------
5951

0 commit comments

Comments
 (0)