Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #7

Open
gw0 opened this issue Sep 24, 2015 · 0 comments
Open

Improve documentation #7

gw0 opened this issue Sep 24, 2015 · 0 comments

Comments

@gw0
Copy link

gw0 commented Sep 24, 2015

Could you improve the documentation, docstring comments and naming of files?

For a newcomer to HDL it took me some time to even figure out what is where and what purpose does it have. Suggestions for name changes:

  • sdram.py --> SdramHwSim.py, because it is a Simulated SDRAM model
  • sd_intf.py --> SdramHwIntf.py, because it is a Interface on SDRAM hardware side
  • host_intf.py --> SdramHostIntf.py, because it is a Interface on host side
  • class MySdramCntl --> class SdramCntl, because it is a general, not mine, SDRAM controller with SdramHwIntf and SdramHostIntf interfaces
  • test_controller.py --> test_SdramCntl.py
  • test_sdram.py --> test_SdramHwSim.py
  • modal --> model (common typo in README.md)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant