influxdata / influxdata/influxdb-client-csharp

XML documentation

Open
#451 2 comments 0 reactions 0 assignees View on GitHub
documentation enhancement help wanted
Dominant language
C#
Stars
377
Forks
93
Avg merge
9m
Merged PRs (30d)
2

Description

__Proposal:__
Add [XML documentation](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/) to all types, methods, etc.

__Current behavior:__
No XML documentation in the libraries.

__Desired behavior:__
All APIs, classes, etc. should be annotated with XML documentation comments.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not name files, tests, or entry points; start by identifying the library projects and their public types and methods. Review the linked XML documentation guidance and inventory the undocumented APIs. Done means all public APIs, classes, and related members have XML documentation comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.