microsoft / microsoft/microsoft-performance-toolkit-sdk
Is there any documentation for AggregationOverTime?
Open
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 239
- Forks
- 78
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 2
Description
AggregationOverTime.cs:
public enum AggregationOverTime
{
//
// TODO: the documentation of these values needs to have additional detail
// added.
//
/// <summary>
/// Aggregates the current values.
/// </summary>
Current,
/// <summary>
/// Aggregates the rate of the values.
/// </summary>
Rate,
/// <summary>
/// Performs a cumulative aggregation.
/// </summary>
Cumulative,
/// <summary>
/// Performs an outstanding aggregation.
/// </summary>
Outstanding,
/// <summary>
/// Performs an aggregation of the peak.
/// </summary>
OutstandingPeak,
}
Is there any documentation for rate, Outstanding, OutstandingPeak?
Thx!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with AggregationOverTime.cs and review the existing XML summaries for the enum values. Determine the intended meanings of Rate, Outstanding, and OutstandingPeak from the SDK context, then update their documentation with enough detail to answer the question and verify the documentation builds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100