dotnet/roslyn

Add code snippets to syntax api docstrings

Aberta

#54.631 aberto em 6 de jul. de 2021

Ver no GitHubGuia do colaborador
 (1 comentário) (1 reação) (0 responsável)C# (4.257 forks)batch import
Area-CompilersConcept-APIFeature Requesthelp wanted

Métricas do repositório

Stars
 (20.414 estrelas)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (256 fundiu PRs em 30d)

Description

Background and Motivation

When I navigate the syntax api with my IDE it is not eaasy to figure out what each SyntaxNode implementation class is representing practially.

Proposed API

Change the docsstrings of Syntax classes to include examples (code snippets of chsarp code showcasing the syntax). These can be long docstrings covering differrent cases and mentioning common misunderstandings and references to other classes / docstrings.

In case there is awesome documentation online that you have in mind. That is great then the docstrings can just include the link for that.

Guia do colaborador

Direção de pesquisa
Identifique uma subclasse de SyntaxNode, examine sua docstring e adicione um trecho de código demonstrando a sintaxe que ela representa. Execute os testes para garantir que não haja erros de compilação.
Pilha de tecnologia
csharp
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.
2
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
C#Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75