add comment on redundancy in PriorityPicker's arguments
authorJacob Lifshay <programmerjake@gmail.com>
Wed, 3 Aug 2022 05:30:59 +0000 (22:30 -0700)
committerJacob Lifshay <programmerjake@gmail.com>
Wed, 3 Aug 2022 05:30:59 +0000 (22:30 -0700)
src/nmutil/picker.py

index f2cf0502f625c61b368d7d16a47594781ce37d56..7cf7f7bd03001f920ce898ab765211d7689832ad 100644 (file)
@@ -36,6 +36,8 @@ class PriorityPicker(Elaboratable):
         * msb_mode is for a MSB-priority picker
         * reverse_i=True is for convenient reversal of the input bits
         * reverse_o=True is for convenient reversal of the output bits
+        * `msb_mode=True` is redundant with `reverse_i=True, reverse_o=True`
+            but is allowed for backwards compatibility.
     """
 
     def __init__(self, wid, msb_mode=False, reverse_i=False, reverse_o=False):