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.

Sign up for GitHub

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

Jump to bottom

Missing documentation for migen.genlib modules #23

Open
1 of 12 tasks
mithro opened this issue Jul 2, 2015 · 1 comment
Open
1 of 12 tasks

Missing documentation for migen.genlib modules #23

mithro opened this issue Jul 2, 2015 · 1 comment
Labels
improvement

Comments

@mithro
Copy link
Contributor

mithro commented Jul 2, 2015 •
edited by whitequark
Loading

The following migen.genlib modules already have inline documentation!

  • coding - Good!
  • sort - Good!

The following migen.genlib modules are missing docstrings or other form of inline documentation;

  • cdc - BusSynchronizer has a dockstring, but others don't.
  • complex - This is just a complex number? - What makes it different from Python's inbuilt complex type?
  • divider - Whats "w"? The width? What is it actually dividing?
  • fsm - Lots of undocumented stuff here.
  • io - These are mostly self explanatory, but still could use information about why they exist?
  • misc - Lots of undocumented stuff here.
  • record - Lots of undocumented stuff here.
  • resetsync - Why does the AsyncResetSynchronizer exist?
  • rob - Lots of undocumented stuff here.
  • roundrobin - switch_policy?

These last two modules are mostly good but need some fixes.

  • mhamgen - The documentation is all in comments rather than in Python doc strings.
  • fifo - Mostly good, but how is SyncFIFOBuffered different?

As I figure out these modules I'll try and start sending patches with documentation myself if no one else has gotten to it first.
@mithro
Copy link
Contributor Author

mithro commented Jul 2, 2015

FYI - @ajitmathew

@architeuthidae architeuthidae mentioned this issue Aug 30, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mithro @whitequark