dotnet / dotnet/runtime

Microsoft.Extensions.Caching.SqlServer docs for .NET 10.0 APIs

Open
#120,484 2 comments 0 reactions 0 assignees View on GitHub
area-Meta documentation help wanted
Dominant language
C#
Stars
18.3k
Forks
5.6k
PR merge metrics
PR metrics pending

Description

# Microsoft.Extensions.Caching.SqlServer docs for .NET 10.0 APIs

## Description

This issue tracks the porting of documentation for 6 APIs in the `Microsoft.Extensions.Caching.SqlServer` namespace that were added in .NET 10.0.

## Instructions

Please follow the instructions in the main tracking issue (#120483) for documenting these APIs.

## Undocumented APIs

The following APIs need documentation:

### SqlServerCache

- [M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions})](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml)
- [M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#Set(System.String,System.Buffers.ReadOnlySequence{System.Byte},Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml)
- [M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#SetAsync(System.String,System.Buffers.ReadOnlySequence{System.Byte},Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml)
- [M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#TryGet(System.String,System.Buffers.IBufferWriter{System.Byte})](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml)
- [M:Microsoft.Extensions.Caching.SqlServer.SqlServerCache.Microsoft#Extensions#Caching#Distributed#IBufferDistributedCache#TryGetAsync(System.String,System.Buffers.IBufferWriter{System.Byte},System.Threading.CancellationToken)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCache.xml)

### SqlServerCacheOptions

- [M:Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions.#ctor](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Caching.SqlServer/SqlServerCacheOptions.xml)

Total APIs to document: 6

Contributor guide

Open the contributing guide

Research direction

Start with the instructions in the main tracking issue, #120483, then inspect the linked SqlServerCache.xml and SqlServerCacheOptions.xml files. Document the five listed SqlServerCache members and the SqlServerCacheOptions constructor for .NET 10.0; done means all six APIs listed here have documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.