dotnet/roslyn

Code documentation of class InteractiveScriptGlobals not complete

Open

#14,690 opened on Oct 23, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-InteractiveInteractive-ScriptingLogichelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

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.

Contributor guide

Research direction
Examine the InteractiveScriptGlobals class in the Roslyn source to identify all public properties and write appropriate XML documentation comments explaining their purpose and usage.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95