dotnet / dotnet/dotnet-api-docs

IHostApplicationLifetime documentation on released artifacts does not match source

Offen
#5,481 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-Extensions-Hosting Pri3 untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

Perhaps I'm am missing something obvious here, but I noticed, that the doc-comment on `IHostApplicationLifetime.ApplicationStopping` in the current artifacts does not match the one that is present in the source code.

With current artifacts I am referring to https://www.nuget.org/packages/Microsoft.Extensions.Hosting.Abstractions/5.0.0
and also https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.ihostapplicationlifetime?view=dotnet-plat-ext-5.0.

I am comparing this to the source at https://github.com/dotnet/runtime/blob/main/src/libraries/Microsoft.Extensions.Hosting.Abstractions/src/IHostApplicationLifetime.cs. Which has not changed (in a relevant manner) since Feb 13, 2020. Those changes were triggered by https://github.com/dotnet/extensions/issues/2962 and merged in https://github.com/dotnet/extensions/pull/2963. All well before version 5.0 was released.

As far as I can tell the issue is still present in https://www.nuget.org/packages/Microsoft.Extensions.Hosting.Abstractions/6.0.0-preview.1.21102.12.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Vergleiche die Dokumentation für IHostApplicationLifetime.ApplicationStopping in IHostApplicationLifetime.cs mit den im Issue verknüpften Artefakten Microsoft.Extensions.Hosting.Abstractions 5.0.0 und 6.0.0-preview.1.21102.12. Beginne mit der Quelldatei und den Paket-/API-Seiten; fertig ist die Aufgabe, wenn die veröffentlichte Dokumentation mit dem Quellkommentar übereinstimmt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.