chisel icon indicating copy to clipboard operation
chisel copied to clipboard

Inconsistency with Decoupled and DecoupledIO

Open mwachs5 opened this issue 3 years ago • 1 comments

It's a source of confusion when to use Decoupled and when to use DecoupledIO -- can we just make them the same name and deprecate the inconsistent name?

Type of issue: feature request

Impact: API modification

Development Phase: request

Other information

If the current behavior is a bug, please provide the steps to reproduce the problem:

No bug What is the current behavior?

You use Decoupled to create the thing but DecoupledIO is the type. This is really confusing.

What is the expected behavior?

They could both just be called Decoupled. And DecoupledIO would alias to Decoupled but pop up as deprecated.

Please tell us about your environment:

What is the use case for changing the behavior?

Less cognitive load

mwachs5 avatar Mar 07 '22 23:03 mwachs5

A better name would actually be ReadyValidIO. This is how it is called in textbooks (e.g., Dally). And when we are about renaming things. The data field should be called data and not bits.

schoeberl avatar Mar 08 '22 02:03 schoeberl