Clarified documentation #63
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
…` specifically looks for `##` or more pound signs
fmulero
approved these changes
Jul 31, 2023
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.
Description of the change
This MR clarified the
README.mddocumentation on the# Parametersrequirement. Where the documentation previously stated that a# Parameterssection is required, it now states that theParameterssection should include at least two#or more symbols.Change was made because
lib/render.js:74only looks for section titles with at least two##symbols.Benefits
I ran into the error that my
# Parameterssection could not be found due to this, so fixing this in the documentation hopefully prevents others from running into the same problem!Checklist
README.mdchange without any code changes.