[Doc] Reference FakeTimeProvider in xml comments to TimeProvider class.

[voroninp]

Background and motivation

Testability is a motivation for introduction of TimeProvider class, thus it would be benefitial for the developers to find out about extras from the documntation.

Curruntly there is no mentioning of FakeTimeProvider class in xmldoc.

API Proposal

I propose to add <remarks> section which will cotnain something like the following:

/// <summary>Provides an abstraction for time.</summary>
/// <remarks>Use FakeTimeProvider class from package Microsoft.Extensions.TimeProvider.Testing for convenient testing.</remarks>
public abstract class TimeProvider

API Usage

N/A

Alternative Designs

No response

Risks

If you ever change the name of the FakeTimeProvider or its package, documentation will become stale.

[colejohnson66]

This belongs in dotnet/dotnet-api-docs.

[voroninp]

@colejohnson66 , are you shure that tech writers are responsible for writing xmldoc comments? Or is it just how you organize issues?

[colejohnson66]

The XML doc comments are not what is shown on the documentation website. The website is generated from the dotnet/dotnet-api-docs repository.

[voroninp]

Yes, and I am speaking about adding the remark to xmldcos.

[tarekgh]

This should be fixed in https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System/TimeProvider.xml.

[tarekgh]

@voroninp are you interested to submit a PR for that?

[voroninp]

@tarekgh , I am a bit confused, though. Are not those xmls just build artefacts?