chipsalliance / chipsalliance/chisel

RFC: Deprecate either Decoupled or DecoupledIO?

Open
#2,463 12 comments 1 reaction 0 assignees View on GitHub
good first issue
Dominant language
Scala
Stars
4.8k
Forks
658
Avg merge
18h 59m
Merged PRs (30d)
14

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.