-
Notifications
You must be signed in to change notification settings - Fork 603
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
Update comments describing Decoupled/ReadyValid - fix #437. #493
Conversation
* enforced via use of concrete subclasses. | ||
* The base protocol implied by the directionality is that the producer uses | ||
* the interface as-is (outputs bits) while the consumer | ||
* uses the flipped interface (inputs bits). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like the comment could be better reflowed here?
* These could be replaced with: | ||
* val enq = Flipped(EnqIO(gen)) | ||
* val deq = Flipped(DeqIO(gen)) | ||
* once issue #492 is resolved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This comment should be changed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What should it be changed to?
It seems there is a valid use case for EnqIO/DeqIO and updating the comments may clear some of the confusion and encourage their usage.
Re-flow comments for ReadyValidIO() Add gen param to DecoupledIO() and IrrevocableIO().
It seems there is a valid use case for EnqIO/DeqIO and updating the comments may clear some of the confusion and encourage their usage.