psake icon indicating copy to clipboard operation
psake copied to clipboard

Help file left with .old extension in en-US dir of the installed module

Open rkeithhill opened this issue 8 years ago • 3 comments

Help seems to work but I'm not sure how.

rkeithhill avatar Nov 23 '17 00:11 rkeithhill

PS shouldn’t find the MAML XML so will revert to the comment-based help on all the functions. Now that we have the help in markdown files via PlatyPS, we can either modify the build task to generate the XML help from them or leave it out entirely.

devblackops avatar Nov 23 '17 00:11 devblackops

Ah. I thought that platyPS would have ripped out the comment-based help when you ran it to generate the markdown files.

Don't we want to generate the MAML help file from the markdown files via platyPS? Otherwise is there any value in using platyPS? Eventually, I think the PS team wants to replace MAML with markdown in the help system.

rkeithhill avatar Nov 23 '17 00:11 rkeithhill

Yes, the comment-based help attached to each function should be removed as that will exist in the PlatyPS MD files. We'll need to add a couple of tasks in build.ps1 to update the MD files as changes are made to the module, and to generate the MAML during the build task.

devblackops avatar Nov 30 '17 06:11 devblackops