chipsalliance/chisel

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

Aberta

#2.087 aberto em 26 de ago. de 2021

Ver no GitHubGuia do colaborador
 (49 comentários) (3 reações) (0 responsável)Scala (651 forks)batch import
good first issue

Métricas do repositório

Stars
 (4.658 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d 21h) (16 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Revise a discussão nos comentários da issue e a documentação existente do Chisel para criar um conjunto de exemplos claros que distingam `:=` e `<>`, e então proponha adicioná los ao cookbook ou site do Chisel.
Pilha de tecnologia
scala
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic Chisel understanding
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85