chipsalliance/chisel

We have no documentation/training on `Mem`

Aberta

#2.324 aberto em 3 de jan. de 2022

Ver no GitHubGuia do colaborador
 (5 comentários) (0 reação) (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

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

We don't have any documentation that I can find on Mem in the Chisel bootcamp, or the website explanations docs or cookbooks. We only cover SyncReadMem.

What is the current behavior?

What is the expected behavior?

We should probably at least mention this in the explanations section

Please tell us about your environment:

What is the use case for changing the behavior?

Not having undocumented features

Guia do colaborador

Direção de pesquisa
Examine a documentação existente para SyncReadMem no bootcamp do Chisel, nas seções de explicações do site e nos cookbooks. Identifique onde Mem deve ser mencionado (por exemplo, junto com SyncReadMem nas primitivas de memória). Crie uma pequena seção que descreva o comportamento e o uso de Mem, semelhante à documentação do SyncReadMem. Atualize os arquivos markdown relevantes no repositório.
Pilha de tecnologia
scala
Domain
documentation
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90