dotnet/roslyn

Code documentation of class InteractiveScriptGlobals not complete

Open

#14 690 ouverte le 23 oct. 2016

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)C# (4 257 forks)batch import
Area-InteractiveInteractive-ScriptingLogichelp wanted

Métriques du dépôt

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

Description

Version Used: 1.3.2

Steps to Reproduce:

  1. Review documentation of class InteractiveScriptGlobals.
  2. Hosts should implement these globals in order to reach standardized hosts.
  3. Review documentation of properties of the class.

Expected Behavior: Would be helpful if host developers know the exact meaning of the properties (e.g. ReferencePaths, SourcePaths). It's really minor, but maybe there will be more properties over time.

Actual Behavior: Properties are not documented.

Guide contributeur

Direction de recherche
Localisez la classe InteractiveScriptGlobals dans le code source de Roslyn (probablement dans le répertoire InteractiveHost). Ajoutez des commentaires de documentation XML pour chaque propriété (par exemple, ReferencePaths, SourcePaths). La documentation doit expliquer la signification et l'utilisation de chaque propriété. Comme il n'y a pas de commentaires existants ni de PR liés, le contributeur doit vérifier l'état actuel de la classe.
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
95