Get-Module - less horizontal scrolling

[petervandivier]

move commentary outside code-blocks to reduce horizontal scrolling

[zjalexander]

❌ Validation status: errors

File	Status	Preview URL	Details
reference/6/Microsoft.PowerShell.Core/Get-Module.md	❌Error		Details
	❌Error		Details

reference/6/Microsoft.PowerShell.Core/Get-Module.md

• [Error] Unable to load file: 6/Microsoft.PowerShell.Core/Get-Module.md via processor: AzureCliDocumentProcessor: :221:(1745) '```powershell
  PS> Get-Content $m.Path

'
 Expect Heading

<a name=""></a>
### []()
 - **[Error]** Markdown.MAML.Transformer.HelpSchemaException: :221:(1745) &#39;```powershell
PS&gt; Get-Content $m.Path

'
Expect Heading
at Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder.GetInnerContexts(DocumentBuildParameters parameters, IEnumerable1 processors, TemplateProcessor templateProcessor, IHostServiceCreator creator) at Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder.BuildCore(DocumentBuildParameters parameters) at Microsoft.DocAsCode.Build.Engine.DocumentBuilder.BuildCore(DocumentBuildParameters parameter, IMarkdownServiceProvider markdownServiceProvider, BuildInfo currentBuildInfo, BuildInfo lastBuildInfo) at Microsoft.DocAsCode.Build.Engine.DocumentBuilder.Build(IList1 parameters, String outputDirectory)
at Microsoft.DocAsCode.SubCommands.DocumentBuilderWrapper.BuildDocument(BuildJsonConfig config, TemplateManager templateManager, String baseDirectory, String outputDirectory, String pluginDirectory, String templateDirectory)
at Microsoft.DocAsCode.SubCommands.DocumentBuilderWrapper.BuildDocument()

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

[zjalexander]

❌ Validation status: errors

File	Status	Preview URL	Details
reference/6/Microsoft.PowerShell.Core/Get-Module.md	❌Error		Details
	❌Error		Details

reference/6/Microsoft.PowerShell.Core/Get-Module.md

• [Error] Unable to load file: 6/Microsoft.PowerShell.Core/Get-Module.md via processor: AzureCliDocumentProcessor: :222:(1745) '```powershell
  PS> Get-Content $m.Path

'
 Expect Heading

<a name=""></a>
### []()
 - **[Error]** Markdown.MAML.Transformer.HelpSchemaException: :222:(1745) &#39;```powershell
PS&gt; Get-Content $m.Path

'
Expect Heading
at Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder.GetInnerContexts(DocumentBuildParameters parameters, IEnumerable1 processors, TemplateProcessor templateProcessor, IHostServiceCreator creator) at Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder.BuildCore(DocumentBuildParameters parameters) at Microsoft.DocAsCode.Build.Engine.DocumentBuilder.BuildCore(DocumentBuildParameters parameter, IMarkdownServiceProvider markdownServiceProvider, BuildInfo currentBuildInfo, BuildInfo lastBuildInfo) at Microsoft.DocAsCode.Build.Engine.DocumentBuilder.Build(IList1 parameters, String outputDirectory)
at Microsoft.DocAsCode.SubCommands.DocumentBuilderWrapper.BuildDocument(BuildJsonConfig config, TemplateManager templateManager, String baseDirectory, String outputDirectory, String pluginDirectory, String templateDirectory)
at Microsoft.DocAsCode.SubCommands.DocumentBuilderWrapper.BuildDocument()

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

[DCtheGeek]

@petervandivier I see what the error here is now, missed it the first read through. The MAML format only allows a code block and then a comment, but not another code block before another header is there. That's part of why all the comments where in the code block so that there was only one code block per header and it didn't violate the MAML formatting rules.

I really like the direction of making it more readable (less scrolling)... can you find a way to do so, but only have one PS code block in each header (example) to stay within the MAML formatting rules?

[petervandivier]

🤞 hopefully this update suffices. the only other idea i had off the top of my head was to linebreak the comments within the markdown code blocks, but then it won't dynamically scale with screen size.

[zjalexander]

✅ Validation status: passed

File	Status	Preview URL	Details
reference/6/Microsoft.PowerShell.Core/Get-Module.md	✅Succeeded	View (powershell-6)

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

[DCtheGeek]

This looks like an acceptable compromise between usability and the MAML rules. I'm going to have @sdwheeler take a look, too, before merging it in.

[DCtheGeek]

@petervandivier @sdwheeler and I talked about this and decided to rotate the sections a bit to be more Intro, Example(s), Explanation in layout (keeping your changes, just re-ordering them). Really appreciate your contribution here and helping improve and streamline this content!

[zjalexander]

✅ Validation status: passed

File	Status	Preview URL	Details
reference/6/Microsoft.PowerShell.Core/Get-Module.md	✅Succeeded	View (powershell-6)

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

[DCtheGeek]

@petervandivier Thanks again... with the update layout, we are merging in. Appreciate the contribution and help here!