Improve documentation with usual caveats #45
Merged
Conversation
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
c573841 to
9165d28
Compare
JPeer264
requested changes
Aug 23, 2019
| @@ -100,6 +100,12 @@ try { | |||
| - [rcs.loadMapping](docs/api/loadMapping.md) | |||
| - [rcs.config](docs/api/config.md) | |||
|
|
|||
| ## Caveats | |||
There was a problem hiding this comment.
Could you add this new section on the Content list?
2c73cf5 to
322c998
Compare
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.
This adds a documents explaining the pattern that works best and those to avoid. I think it's required for newcomers.