chipsalliance/chisel

RFC: Deprecate either Decoupled or DecoupledIO?

Ouverte

#2 463 ouverte le 28 mars 2022

 (12 commentaires) (1 réaction) (0 personne assignée)Scala (651 forks)batch import
good first issue

Métriques du dépôt

Stars
 (4 658 étoiles)
Métriques de merge PR
 (Merge moyen 3j 21h) (16 PRs mergées en 30 j)

Description

Type of issue: feature request

Impact: API modification

Development Phase: proposal

Other information

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

What is the current behavior?

User does something like:

val foo: DecoupledIO[Bar] = Decoupled(bar)

There is a mental burden to remember which one is DecoupledIO and which one is Decoupled, for no good reason.

What is the expected behavior?

User would write:

val foo: Decoupled[Bar] = Decoupled(bar)

OR

val foo: DecoupledIO[Bar] = DecoupledIO(bar)

We'd deprecate the other one for a version or so.

Similar for ReadyValids and such, I didn't do a comprehensive survey

Please tell us about your environment:

What is the use case for changing the behavior?

Less mental load for users.

Guide contributeur