chipsalliance/chisel

RFC: Deprecate either Decoupled or DecoupledIO?

Open

#2,463 opened on Mar 28, 2022

View on GitHub
 (12 comments) (1 reaction) (0 assignees)Scala (651 forks)batch import
good first issue

Repository metrics

Stars
 (4,658 stars)
PR merge metrics
 (Avg merge 3d 21h) (16 merged PRs in 30d)

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.

Contributor guide

Research direction
Compare usage patterns of Decoupled and DecoupledIO across the codebase, then propose deprecation of one, following the current deprecation policy.
Tech stack
scala
Domain
compilers
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaChisel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70