Remove uninformative 'Further Reading' sections from rule docs #131
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
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.
Issue: #
What Changed
Some of the rules have a 'Further Reading' section that don't provide any additional reading materials. I simply removed them in this PR.
I considered modifying the template in generate-rule.ts too, but I can't think of a good way to do it since the writer will have to manually delete the section header anyway, if they have nothing to write for a given optional section.
Checklist
Check the ones applicable to your change:
yarn update-allChange Type
Indicate the type of change your pull request is:
maintenancedocumentationpatchminormajor