chipsalliance/chisel

RFC: Deprecate either Decoupled or DecoupledIO?

Aperta

#2463 aperta il 28 mar 2022

Vedi su GitHubGuida contributor
 (12 commenti) (1 reazione) (0 assegnatari)Scala (651 fork)batch import
good first issue

Metriche repository

Star
 (4658 stelle)
Metriche merge PR
 (Merge medio 3g 21h) (16 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Confronta i modelli di utilizzo di Decoupled e DecoupledIO nell'intero codebase, quindi proponi la deprecazione di uno, seguendo l'attuale politica di deprecazione.
Tech stack
scala
Dominio
compilers
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ScalaChisel
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70