chipsalliance/chisel

Better documentation of `:=` vs `<>`

Open

#2,087 opened on Aug 26, 2021

View on GitHub
 (49 comments) (3 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

Type of issue: documentation

Impact: no functional change

Development Phase: request

Other information

I feel like I have been in several conversations lately about how confusing := and <> are. And I'm not even 100% confident that I could explain what each does in every scenario. This seems like something that a few Scastie examples + DecoupledIOs could "put to rest" and we could capture them as a cookbook or explanation on the website.

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

N/A

What is the current behavior? N/A

What is the expected behavior? N/A Please tell us about your environment:

N/A What is the use case for changing the behavior?

Better documentation of an FAQ

Contributor guide

Research direction
Review the discussion in the issue comments and existing Chisel documentation to create a set of clear examples distinguishing `:=` and `<>`, then propose adding them to the Chisel cookbook or website.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
Basic Chisel understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85