Ensure external help file from metadata is used for generating the MAML file name #779
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This pull request introduces changes to improve the handling of external help files in the help generation system. The updates ensure better organization and compatibility across platforms, as well as enhance metadata handling for command help objects.
Improvements to help file grouping and naming:
src/Command/ExportMamlCommandHelp.cs: Updated the grouping logic inEndProcessing()to prioritizeExternalHelpFileoverModuleNameand added ordering by group key. Modified the help file name generation to useExternalHelpFileif available.Platform compatibility:
src/Common/MetadataUtils.cs: Added a comment explaining the use of upper case for "Help.xml" file names to avoid issues on non-Windows platforms.Enhanced metadata handling:
src/Transform/TransformBase.cs: UpdatedConvertCmdletInfo()to set theExternalHelpFileproperty based on metadata, ensuring it defaults to an empty string if no value is provided.PR Context