dotnet/roslyn

Code documentation of class InteractiveScriptGlobals not complete

Open

#14.690 aperta il 23 ott 2016

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C# (4257 fork)batch import
Area-InteractiveInteractive-ScriptingLogichelp wanted

Metriche repository

Star
 (20.414 star)
Metriche merge PR
 (Merge medio 6g 17h) (256 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Individua la classe InteractiveScriptGlobals nel codice sorgente di Roslyn (probabilmente nella directory InteractiveHost). Aggiungi commenti di documentazione XML per ogni proprietà (ad esempio, ReferencePaths, SourcePaths). La documentazione dovrebbe spiegare il significato e l'utilizzo di ciascuna proprietà. Poiché non ci sono commenti esistenti o PR collegati, il contributore deve verificare lo stato attuale della classe.
Tech stack
csharp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
95