dotnet/roslyn

Code documentation of class InteractiveScriptGlobals not complete

Open

#14.690 geöffnet am 23. Okt. 2016

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (4.257 Forks)batch import
Area-InteractiveInteractive-ScriptingLogichelp wanted

Repository-Metriken

Stars
 (20.414 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (256 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Suchen Sie die Klasse InteractiveScriptGlobals im Roslyn Quellcode (wahrscheinlich im Verzeichnis InteractiveHost). Fügen Sie XML Dokumentationskommentare für jede Eigenschaft hinzu (z. B. ReferencePaths, SourcePaths). Die Dokumentation sollte die Bedeutung und Verwendung jeder Eigenschaft erklären. Da es keine vorhandenen Kommentare oder verknüpfte PRs gibt, muss der Mitwirkende den aktuellen Zustand der Klasse überprüfen.
Tech Stack
csharp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95