This MR clarified the README.md documentation on the # Parameters requirement. Where the documentation previously stated that a # Parameters section is required, it now states that the Parameters section should include at least two # or more symbols.
Change was made because lib/render.js:74 only looks for section titles with at least two ## symbols.
Benefits
I ran into the error that my # Parameters section could not be found due to this, so fixing this in the documentation hopefully prevents others from running into the same problem!
Checklist
Removed all checks, since none are relevant for a README.md change without any code changes.
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.