dotnet/roslyn

Add code snippets to syntax api docstrings

Ouverte

#54 631 ouverte le 6 juil. 2021

Voir sur GitHubGuide contributeur
 (1 commentaire) (1 réaction) (0 personne assignée)C# (4 257 forks)batch import
Area-CompilersConcept-APIFeature Requesthelp wanted

Métriques du dépôt

Stars
 (20 414 étoiles)
Métriques de merge PR
 (Merge moyen 6j 17h) (256 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Identifiez une sous classe de SyntaxNode, examinez sa docstring et ajoutez un extrait de code illustrant la syntaxe qu'elle represente. Executez les tests pour vous assurer qu'il n'y a pas d'erreurs de build.
Stack technique
csharp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75