dotnet / dotnet/dotnet-api-docs

Missing xmldocs for Microsoft.Extensions.Caching.Memory CacheExtensions

Open
#6,871 3 comments 0 reactions 0 assignees View on GitHub
area-Extensions-Caching Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

There's no xmldocs for [MemoryCacheExtensions](https://github.com/aspnet/Caching/blob/master/src/Microsoft.Extensions.Caching.Abstractions/MemoryCacheExtensions.cs), 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](https://docs.microsoft.com/en-us/dotnet/api/system.collections.concurrent.concurrentdictionary-2.addorupdate?view=net-5.0)

As can be seen in [this GH issue](https://github.com/dotnet/runtime/issues/36499), and from my own experience, people often get tripped up by this fact.

Thanks!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.