Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port missing API documentation for System.CommandLine #9228

Closed
wants to merge 6 commits into from

Conversation

carlossanlop
Copy link
Member

The undoc APIs report I generate every week says we're missing documentation in Microsoft Learn for several (or maybe all) the System.CommandLine APIs, so I'm porting them using our PortToDocs tool from https://github.com/dotnet/api-docs-sync, which we use for runtime.

 PortToDocs.exe -Docs C:\Users\calope\source\repos\dotnet-api-docs\xml -Intellisense C:\Users\calope\source\repos\command-line-api\artifacts -IncludedAssemblies "System.CommandLine" -IncludedNamespaces "System.CommandLine" -SkipInterfaceImplementations false -Save true -DisablePrompts false

Please review the PR ignoring whitespace. The tool is changing the encoding.

@learn-build-service-prod

This comment was marked as outdated.

@carlossanlop carlossanlop marked this pull request as draft August 29, 2023 20:21
@learn-build-service-prod
Copy link

Learn Build status updates of commit d62fdca:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.CommandLine.Help/TwoColumnHelpRow.xml 💡Suggestion View Details
xml/System.CommandLine/ArgumentArity.xml 💡Suggestion View Details
xml/System.CommandLine.Binding/BindingContext.xml ✅Succeeded View
xml/System.CommandLine.Binding/BoundValue.xml ✅Succeeded View
xml/System.CommandLine.Completions/CompletionItem.xml ✅Succeeded View
xml/System.CommandLine.Parsing/ArgumentResult.xml ✅Succeeded View
xml/System.CommandLine.Parsing/ParseError.xml ✅Succeeded View

xml/System.CommandLine.Help/TwoColumnHelpRow.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Equals(System.CommandLine.Help.TwoColumnHelpRow) for uid: System.CommandLine.Help.TwoColumnHelpRow.Equals(System.CommandLine.Help.TwoColumnHelpRow).

xml/System.CommandLine/ArgumentArity.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:Equals(System.CommandLine.ArgumentArity) for uid: System.CommandLine.ArgumentArity.Equals(System.CommandLine.ArgumentArity).

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:

@tannergooding
Copy link
Member

@carlossanlop is this still draft or is it ready for review?

@jeffhandley
Copy link
Member

Per dotnet/command-line-api#2338, we can close this out.

@jeffhandley jeffhandley closed this Mar 5, 2024
@carlossanlop carlossanlop deleted the CommandLineApi branch August 6, 2024 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants