IConfigurationProvider.GetReloadToken nullable annotation

[philipborg]

Description

The XML-Doc says_
<returns>An <see cref="IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
while the return type annotation claims that it shouldn't return null, directly contradicting the XML-Doc.

Reproduction Steps

Read this

runtime/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/IConfigurationProvider.cs

Lines 32 to 33 in d4601d3

	/// <returns>An <see cref="IChangeToken"/> token if this provider supports change tracking, <see langword="null"/> otherwise.</returns>
	IChangeToken GetReloadToken();

Expected behavior

The nullable annotation is consistent with the XML-Doc.

Actual behavior

The nullable annotation contradicts the XML-Doc.

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/area-extensions-configuration
See info in area-owners.md if you want to be subscribed.

[tarekgh]

Looking at the implementations of GetReloadToken, this method never returns null. We may need to fix the Xml-doc and the public doc too. The doc of IConfiguration seems correct but the Xml-doc seems not.

@philipborg are you interested to submit a PR to fix the Xml-doc and the public doc too?

[philipborg]

@tarekgh I could make time to fix it sometime during the week.