Put parameters at the bottom in README#16
Open
UnrealQuester wants to merge 1 commit into
Open
Conversation
The README is the first thing users will see on github and puppetforge. Newcomers will most likely want to know what this module does and how to use it. On most modules the parameter list is at the end of the file, so new users might thing this module is lacking examples and other basic documentation even though it exists at the bottom of the file.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The README is the first thing users will see on github and puppetforge. Newcomers will most likely want to know what this module does and how to use it. On most modules the parameter list is at the end of the file, so new users might thing this module is lacking examples and other basic documentation even though it exists at the bottom of the file.