dotnet / dotnet/dotnet-api-docs

Stronger wording needed

Open
#1,789 1 comment 0 reactions 0 assignees View on GitHub
area-System.Data.SqlClient dotnet-api/prod Pri2 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

Documentation states:
The cancellation token can be used...

Should instead say
The cancelation token will be used... since passing null will result in an exception (looks like it from the first look at https://referencesource.microsoft.com/#System.Data/System/Data/SqlClient/SqlDataReader.cs,f3a8ec4442971b00,references)

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: f2e14e9c-856f-e965-9cb0-2bd9ff7df919
* Version Independent ID: 446389f6-2dd7-9cba-65a1-58f11470499b
* Content: [SqlDataReader.ReadAsync(CancellationToken) Method (System.Data.SqlClient)](https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqldatareader.readasync?view=netframework-4.7.2)
* Content Source: [xml/System.Data.SqlClient/SqlDataReader.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Data.SqlClient/SqlDataReader.xml)
* Product: **dotnet-api**
* GitHub Login: @douglaslMS
* Microsoft Alias: **douglasl**

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.