unoplatform/Uno.Core

Extension methods should be documented

Aperta

#74 aperta il 29 ott 2020

Vedi su GitHubGuida contributor
 (0 commenti) (2 reazioni) (0 assegnatari)C# (13 fork)auto 404
good first issuehelp wanted

Metriche repository

Star
 (40 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

I'm submitting a...

  • Documentation issue or request

Current behavior

Most of the extension methods in Uno.Core (eg here https://github.com/unoplatform/Uno.Core/blob/master/src/Uno.Core/Collections/EnumerableExtensions.cs) lack xml documentation.

Expected behavior

Methods are documented with what they actually do.

Minimal reproduction of the problem with instructions

Environment

Nuget Package: 

Package Version(s): 

Affected platform(s):
- [ ] iOS
- [ ] Android
- [ ] WebAssembly
- [ ] Windows
- [ ] Build tasks

Visual Studio
- [ ] 2017 (version: )
- [ ] 2017 Preview (version: )
- [ ] for Mac (version: )

Relevant plugins
- [ ] Resharper (version: )

Guida contributor

Direzione di ricerca
Aggiungi commenti di documentazione XML a tutti i metodi di estensione pubblici nel progetto Uno.Core. Controlla gli esempi esistenti nel codice per le linee guida di stile.
Tech stack
csharp
Dominio
backenddeveloper experience
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#GitXML documentation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85