Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

There is no description of the MemoryCache Compact() method. #10662

Open
Protiguous opened this issue Nov 9, 2024 · 2 comments
Open

There is no description of the MemoryCache Compact() method. #10662

Protiguous opened this issue Nov 9, 2024 · 2 comments
Labels
area-Extensions-Caching Pri3 Indicates issues/PRs that are low priority

Comments

@Protiguous
Copy link

Type of issue

Missing information

Description

There is no description of what this Compact() method does, why to use it, and when to use it.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.caching.memory.memorycache.compact?view=net-8.0-pp&devlangs=csharp&f1url=%3FappId%3DDev17IDEF1%26l%3DEN-US%26k%3Dk(Microsoft.Extensions.Caching.Memory.MemoryCache.Compact)%3Bk(DevLang-csharp)%26rd%3Dtrue

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml

Document Version Independent Id

f172b18c-858d-4cb4-b094-b6b74947fdc6

Article author

@dotnet-bot

@issues-automation issues-automation bot added the Pri3 Indicates issues/PRs that are low priority label Nov 9, 2024
@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Nov 9, 2024
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-extensions-caching

@adamsitnik
Copy link
Member

You are right, this method should be documented.

For now I can only refer you to the implementation that contains a comment that explains what it does:

https://github.com/dotnet/runtime/blob/6accd39f5852f4a687903a3b19a2d4ac10c2f9e0/src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs#L525-L532

@adamsitnik adamsitnik removed the untriaged New issue has not been triaged by the area owner label Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Extensions-Caching Pri3 Indicates issues/PRs that are low priority
Projects
None yet
Development

No branches or pull requests

2 participants