chipsalliance/chisel

Inconsistency with Decoupled and DecoupledIO

Open

#2,436 opened on Mar 7, 2022

View on GitHub
 (1 comment) (0 reactions) (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

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

Contributor guide

Research direction
Investigate the current usage of DecoupledIO vs Decoupled, plan deprecation, and implement backward compatible deprecation.
Tech stack
scala
Domain
developer experience
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.
1-3 hours
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.
75