search

enjoy-digital / litedram

Small footprint and configurable DRAM core
Other
365 stars 115 forks source link

Add docstrings to litedram.core modules #179

Closed jedrzejboczar closed 4 years ago

jedrzejboczar commented 4 years ago

While writing tests for https://github.com/enjoy-digital/litedram/issues/155 I've been also filling in the documentation of these modules. This PR gathers my notes and adds missing docstrings for core modules. Please review them to check if there are no mistakes.

I also found that there was some dead code in crossbar.py. It seems that it is not needed, but correct me if I'm wrong. https://github.com/enjoy-digital/litedram/commit/1f246cbb88b9d2c286eb7f3492edbfde93fe02d7 removes these parts, and fixes indentation in the for loops.