This repository has been archived by the owner on Jan 19, 2021. It is now read-only.
Where can I find Help on writing Help? #2808
Unanswered
ToddKlindt
asked this question in
Q&A
Replies: 1 comment 1 reply
-
Hi Todd, the easiest would be to take an existing cmdlet and see how it's done there. But indeed it would be better to have some documentation available in the wiki. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
One of the things I'm starting to focus on is adding more Help to the PnP cmdlets. For those that haven't done it yet, the Help and Examples for each cmdlet are defined in the .CS file for that cmdlet. I can't find any documentation on how to write help in .CS. I want to do things like add Description text, Related Links, and so on. I've looked at this documentation on how to write PowerShell cmdlet help, but it's XML files and I don't see how the formatting in there maps to the format I see in the .CS file.
Can someone point me in the right direction?
Beta Was this translation helpful? Give feedback.
All reactions