search

UCSBarchlab / PyRTL

A collection of classes providing simple hardware specification, simulation, tracing, and testing suitable for teaching and research. Simplicity, usability, clarity, and extensibility are the overarching goals, rather than performance or optimization.
http://ucsbarchlab.github.io/PyRTL
BSD 3-Clause "New" or "Revised" License
253 stars 76 forks source link

parameter fix in the documentation for synthesize method (merge_io_vectors) #453

Closed VarunRao21 closed 2 months ago

VarunRao21 commented 2 months ago

In passes.py, the param documentation says a method is called 'merge_io_wirevectors', while in the code it is called 'merge_io_vectors' (https://github.com/UCSBarchlab/PyRTL/blob/development/pyrtl/passes.py#L468C17-L468C37). This is reflected on the PyRTL docs: https://pyrtl.readthedocs.io/en/latest/analysis.html#synthesis.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.4%. Comparing base (f6fee07) to head (fcfb59f).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## development #453 +/- ## =========================================== Coverage 91.4% 91.4% =========================================== Files 24 24 Lines 6416 6416 =========================================== Hits 5861 5861 Misses 555 555 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

VarunRao21 commented 2 months ago

Updated commit message. Thanks for the feedback!

fdxmw commented 2 months ago

Updated commit message. Thanks for the feedback!

Hmm, I still see "documentation fix" as the commit message here https://github.com/UCSBarchlab/PyRTL/pull/453/commits

VarunRao21 commented 2 months ago

Oops, please try again now.