allDone and routeDiscoveryDone Documentation Update #1151
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
Updated what the routeDiscoveryDone plugin does and gave a brief example of it ISSUES CLOSED: scullyio#1115
Updated the documentation for the allDone plugin type with a skeleton example ISSUES CLOSED: scullyio#1115
|
|
SanderElias
approved these changes
Dec 1, 2020
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The documentation for
allDoneandrouteDiscoveryDoneis minimal and somewhat confusing.Issue Number: #1115
What is the new behavior?
The explanation for the
allDoneandrouteDiscoveryDoneplugins was minimal. This expands it a little bit and gives an example of how to create each type of plugin.Does this PR introduce a breaking change?
Other information
More information can easily be added if there are more specific examples of when to use the plugins, particularly
allDone.