Script-based cmdlet help not loaded when DLL and PSM1 share the same base name

[sdwheeler]

The SCCM ConfigurationManager module consists of two files:

• AdminUI.PS.dll
• AdminUI.PS.psm1

Both files contain cmdlets.

New-MarkdownHelp creates the following help files.

• AdminUI.PS.dll-Help.xml
• AdminUI.PS-help.xml

PowerShell only loads the help from AdminUI.PS.dll-Help.xml. If you change the name of the second help file to AdminUI.PS.psm1-help.xml, then help is loaded from both files.

According to this document: https://docs.microsoft.com/powershell/scripting/developer/help/naming-help-files#script-workflow-help-files, the correct filename should be <ScriptModule>.psm1-help.xml.

New-MarkdownHelp needs to create that filename in the external help file: metadata of the cmdlet markdown file.

[adityapatwardhan]

Looking at the Get-Help code, the logic for looking up a help file is as follows:

1. Look for -Help.xml
2. If not found then, look for -Help.xml. If there are multiple nested modules, then we check which nested module hash the cmdlet we are looking up help for. Then append -Help.xml to find the file.

I need more information about the nested modules defined in the psd1 and also which cmdlet help is searched for when only AdminUI.PS.dll-Help.xml was loaded.

[sdwheeler]

@aczechowski Can you attach a copy of the module manifest?

[aczechowski]

I had a chat with Sean, shared some files with him...let me know if you need anything further from me.
Also, I'll be travelling for the next two weeks. I'll be working part-time, but will respond when I can. @mestew is a good alternate for ConfigMgr docs if you need a quick answer. And if you have any ConfigMgr module-specific questions, @ameltzerMSFT is the best POC.