Document branch_format and line_start options
#9
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
Although they were documented in the source already, they should also be documented more visibly. This commit adds documentation for these new options to the README of the project.
|
Looks good, thanks! |
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.
Although they were documented in the source already, they should also be documented more visibly. This commit adds documentation for these new options to the README of the project.
You can view the rendered README at my fork if you want.
Note that I refrained from updating the version number. I'll leave it up to you to decide if this is worthy of bumping it or not, and how (minor or patch increment).
If you have any comments, I can make changes and rebase them onto this commit before merging.