Skip to content

Conversation

gewarren
Copy link
Contributor

Fixes #9991

View by commit.

@ghost ghost added the area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable. label Nov 14, 2024
Copy link
Contributor

@gewarren - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates in the /// comments in the dotnet/runtime repo (or dotnet/extensions repo) instead.

This comment was marked as outdated.

@gewarren gewarren enabled auto-merge (squash) November 14, 2024 04:11

This comment was marked as outdated.

@carlossanlop
Copy link
Contributor

A bunch of xrefs are not working.

This comment was marked as outdated.

Copy link

Learn Build status updates of commit 9cfbf18:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.DependencyInjection/AsyncStateExtensions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml ⚠️Warning View Details
xml/System.Formats.Nrbf/ArrayRecord.xml ⚠️Warning View Details
xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml 💡Suggestion View Details
xml/Microsoft.Extensions.AI/ConfigureOptionsChatClient.xml 💡Suggestion View Details
xml/Microsoft.Extensions.AI/ConfigureOptionsEmbeddingGenerator`2.xml 💡Suggestion View Details
xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml 💡Suggestion View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml 💡Suggestion View Details
xml/Microsoft.Extensions.DependencyInjection/ServiceLifetime.xml 💡Suggestion View Details
xml/Microsoft.Extensions.Hosting/BackgroundServiceExceptionBehavior.xml 💡Suggestion View Details
xml/Microsoft.Extensions.Http.Diagnostics/HttpRouteParameterRedactionMode.xml 💡Suggestion View Details
_zip/missingapi.yml ✅Succeeded
xml/FrameworksIndex/net-6.0-pp.xml ✅Succeeded
xml/FrameworksIndex/net-7.0-pp.xml ✅Succeeded n/a (file deleted or renamed)
xml/FrameworksIndex/net-8.0-pp.xml ✅Succeeded
xml/FrameworksIndex/net-9.0-pp.xml ✅Succeeded
xml/FrameworksIndex/net-9.0.xml ✅Succeeded
xml/FrameworksIndex/netframework-4.7-pp.xml ✅Succeeded
xml/FrameworksIndex/netframework-4.7.1-pp.xml ✅Succeeded
xml/FrameworksIndex/netframework-4.7.2-pp.xml ✅Succeeded
xml/FrameworksIndex/netframework-4.8-pp.xml ✅Succeeded
xml/FrameworksIndex/netframework-4.8.1-pp.xml ✅Succeeded
xml/FrameworksIndex/netstandard-2.0-pp.xml ✅Succeeded
xml/FrameworksIndex/netstandard-2.1-pp.xml ✅Succeeded

This comment lists only the first 25 files in the pull request.

xml/Microsoft.Extensions.DependencyInjection/AsyncStateExtensions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.AsyncState.IAsyncLocalContext`1'.

xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Hosting.Internal.ConsoleLifetime.HostOptions'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Hosting.Internal.ConsoleLifetime.HostOptions'.

xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Http.DefaultHttpClientFactory'.

xml/System.Formats.Nrbf/ArrayRecord.xml

  • [Warning: file-not-redirected - See documentation] File xml/System.Formats.Nrbf/ArrayRecord.xml with URL /dotnet/api/system.formats.nrbf.arrayrecord.flattenedlength was deleted without redirection. To avoid broken links, add a redirection.

xml/Microsoft.Extensions.AI/AdditionalPropertiesDictionary.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:TryGetValue(System.String,System.Object@) for uid: Microsoft.Extensions.AI.AdditionalPropertiesDictionary.TryGetValue(System.String,System.Object@).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:Microsoft.Extensions.AI.AdditionalPropertiesDictionary.TryGetValue(System.String,System.Object@).

xml/Microsoft.Extensions.AI/ConfigureOptionsChatClient.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:Microsoft.Extensions.AI.ConfigureOptionsChatClient.CompleteAsync(System.Collections.Generic.IList{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatOptions,System.Threading.CancellationToken).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:Microsoft.Extensions.AI.ConfigureOptionsChatClient.CompleteStreamingAsync(System.Collections.Generic.IList{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatOptions,System.Threading.CancellationToken).

xml/Microsoft.Extensions.AI/ConfigureOptionsEmbeddingGenerator`2.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundDocs] Inheritdoc tag exists but no inheritdoc found for uid:Microsoft.Extensions.AI.ConfigureOptionsEmbeddingGenerator`2.GenerateAsync(System.Collections.Generic.IEnumerable{`0},Microsoft.Extensions.AI.EmbeddingGenerationOptions,System.Threading.CancellationToken).

xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:CreateServiceProvider(Microsoft.Extensions.DependencyInjection.IServiceCollection) for uid: Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateServiceProvider(Microsoft.Extensions.DependencyInjection.IServiceCollection).

xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Contains(Microsoft.Extensions.DependencyInjection.ServiceDescriptor) for uid: Microsoft.Extensions.DependencyInjection.ServiceCollection.Contains(Microsoft.Extensions.DependencyInjection.ServiceDescriptor).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:CopyTo(Microsoft.Extensions.DependencyInjection.ServiceDescriptor[],System.Int32) for uid: Microsoft.Extensions.DependencyInjection.ServiceCollection.CopyTo(Microsoft.Extensions.DependencyInjection.ServiceDescriptor[],System.Int32).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:IndexOf(Microsoft.Extensions.DependencyInjection.ServiceDescriptor) for uid: Microsoft.Extensions.DependencyInjection.ServiceCollection.IndexOf(Microsoft.Extensions.DependencyInjection.ServiceDescriptor).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Insert(System.Int32,Microsoft.Extensions.DependencyInjection.ServiceDescriptor) for uid: Microsoft.Extensions.DependencyInjection.ServiceCollection.Insert(System.Int32,Microsoft.Extensions.DependencyInjection.ServiceDescriptor).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Remove(Microsoft.Extensions.DependencyInjection.ServiceDescriptor) for uid: Microsoft.Extensions.DependencyInjection.ServiceCollection.Remove(Microsoft.Extensions.DependencyInjection.ServiceDescriptor).

xml/Microsoft.Extensions.DependencyInjection/ServiceLifetime.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

xml/Microsoft.Extensions.Hosting/BackgroundServiceExceptionBehavior.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

xml/Microsoft.Extensions.Http.Diagnostics/HttpRouteParameterRedactionMode.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gewarren
Copy link
Contributor Author

@carlossanlop I think the rest of the broken xrefs are beyond my control (they are internal types so not published on docs). Could you approve?

Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a reasonable skimming of this commit-by-commit. This LGTM.

Let's :shipit:

@gewarren gewarren merged commit 6d2d651 into dotnet:main Nov 14, 2024
4 checks passed
@gewarren gewarren deleted the net9-ga-chunked-redo branch November 14, 2024 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Meta Concerns something that extends across runtime area boundaries, for example, IDisposable.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API ref for .NET 9 GA
3 participants