Improved documentation for reload* values
#1906
Open
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
I've run into a few issues trying to figure out what the correct values are for the various `reload*` configuration values. I've added some more detail to parameter documentation and updated it to be more consistent between the three values.
|
This would have saved me half an hour if the default value was correct in the documentation 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've run into a few issues trying to figure out what the correct values are for the various
reload*configuration values:reloadThrottle,reloadDebounce, andreloadDelay. I've added some more detail to parameter documentation to make it more clear what effect each value has and the differences between it and the other properties and I tried to make them more consistent between the three values.Let me know if these changes should go elsewhere. I didn't see an obvious place in the website repo, so my assumption is that documentation here is automatically pulled out to generate the pages there.