Adding docs about fallback parameters #460
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
lance
approved these changes
Sep 10, 2020
There was a problem hiding this comment.
@helio-frota - yes, if you are updating docs, npm run build is needed. The site is published from the master branch in the /docs directory.
README.md
Outdated
| @@ -76,6 +76,21 @@ the `open` state. | |||
| When a fallback function is triggered, it's considered a failure, and the | |||
| fallback function will continue to be executed until the breaker is closed. | |||
|
|
|||
| Also the fallback function accepts the same parameters as the fire function: | |||
There was a problem hiding this comment.
Nit:
Suggested change
| Also the fallback function accepts the same parameters as the fire function: | |
| The fallback function accepts the same parameters as the fire function: |
There was a problem hiding this comment.
Thank you. PR updated 👍
There was a problem hiding this comment.
I believe when we do a release, the docs are updated as part of that npm script, so that should take care of it. I've created an issue for trying to automate the doc creation also, #461
We could also see about using release-please for doing releases, similar to what we are about to do on the js cloudevents SDK library, cloudevents/sdk-javascript#329
lholmquist
approved these changes
Sep 10, 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.
2BA2
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.
Related to #459
@lance @lholmquist I'm not 100% sure if we need to run
npm run build:docsbefore to send the PR when updating the docs.