Skip to content

Missing xmldocs for Microsoft.Extensions.Caching.Memory CacheExtensions  #6871

Open
@ericsampson

Description

@ericsampson

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Pri3Indicates issues/PRs that are low priorityarea-Extensions-CachinguntriagedNew issue has not been triaged by the area owner

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions