search

dfinke / ImportExcel

PowerShell module to import/export Excel spreadsheets, without Excel
https://www.powershellgallery.com/packages/ImportExcel/
Apache License 2.0
2.48k stars 400 forks source link

Import-Excel help is missing the -ImportColumns parameter #1663

Closed KeithALane closed 2 days ago

KeithALane commented 3 days ago

I had a reason to use the Import-Excel -ImportColumns parameter today, and noticed that the parameter seems to be missing from the .xml help.

I think the files that would need to change are: mdHelp/en/import-excel.md en/ImportExcel-help.xml

There is an related example Examples/ImportColumns/ImportColumns.ps1

The sections that would need updating are SYNTAX, PARAMETERS, EXAMPLES

I haven't worked on these type of help files with PlatyPS yet so I might try and figure out the process at some point.

dfinke commented 3 days ago

@KeithALane thanks for using ImportExcel. Correct, there is no help for that. Never got around to build a workflow for PlatyPS building the help.

Check out the examples - I believe there is one for Import Columns.

https://github.com/dfinke/ImportExcel/tree/master/Examples

KeithALane commented 3 days ago

I think I figured out the process with PlatyPS... it was a bit trickier than I was expecting. PlatyPS didn't like the ASCII art tables in the examples section and wouldn't validate unless I added a comment tag before them.

When I got to GitHub it was detecting every line as a change which appeared to be due to the line widths changing when I ran PlatyPS's New-MarkdownHelp. So instead of that I manually marked up the changes in this branch. https://github.com/dfinke/ImportExcel/compare/master...KeithALane:ImportExcel:ImportColumns?expand=1

I'm not going to try and claim that what I changed is correct or even a good description, as this is the first time I've even attempted editing markdown/xml using PlatyPS. So rather than submitting a PR, I'd prefer to let you fix it in a way that is consistent with whatever practices you are using to manage the other help files.

I also noticed the -Raw parameter also appears to be missing in the same way.

Anyway, thanks for the great module, I use it every day!

dfinke commented 2 days ago

@KeithALane thanks! Yeah, not a fan of docs, I prefer examples. Even for my newer modules I am still looking for a good way to produce and maintain docs.

Maybe one day.