dotnet / dotnet/dotnet-api-docs

Missing xmldocs for Microsoft.Extensions.Caching.Memory CacheExtensions

Aperta
#6,871 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

area-Extensions-Caching Pri3 untriaged
Lingua principale
C#
Stelle
950
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

There's no xmldocs for MemoryCacheExtensions, which makes the online API browser docs and intellisense of little use.

Also, these docs should really include a mention that the GetOrCreate/GetOrCreateAsync factories is not blocked for re-entrancy unless the programmer implements that themselves (easiest way is to use Lazy)

For an example of good documentation of the same topic for a different class, check out the Remarks for ConcurrentDictionary AddOrUpdate

As can be seen in this GH issue, and from my own experience, people often get tripped up by this fact.

Thanks!

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con src/Microsoft.Extensions.Caching.Abstractions/MemoryCacheExtensions.cs e confronta la relativa documentazione XML con le annotazioni dell'API ConcurrentDictionary AddOrUpdate collegate nell'issue. Documenta i membri di MemoryCacheExtensions, incluso il comportamento di rientranza delle factory di GetOrCreate e GetOrCreateAsync, in modo che il browser API generato e IntelliSense spieghino questa limitazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.