Adds help topic for module. #287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you ship this then users of posh-git will be able to execute "man about_posh-git" and get the info that is currently in the readme.md file. It is recommended that PowerShell modules provide an about help topic for users to get started with using a module. It is also a very handy way looking up the "legend" for the status prompt.
|
It would be neat to generate this from the readme somehow, but we'll live with double maintenance for now. Thanks for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you ship this then users of posh-git will be able to execute "man about_posh-git" and get the info that is currently in the readme.md file. It is recommended that PowerShell modules provide an about help topic for users to get started with using a module. It is also a very handy way of looking up the "legend" for the status prompt.
In case someone has their console width set to 80 chars, we limit each line's length to fewer than 80 chars. Also, PowerShell help files are just text which get dumped to the console. There is currently no support for markdown rendering.