docs: add section on error values to resource author's guide #347
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
ryane
reviewed
Oct 3, 2016
| ### Dealing with Errors | ||
|
|
||
| The default `Status` implementation has a `SetError(error)` method. When called, | ||
| it sets an appropriate error level and an internal error state that will be |
There was a problem hiding this comment.
should you also return the error if you call SetError?
There was a problem hiding this comment.
good point, I've added a section to clarify in ebd589c
| presented to the user. You can also use the common Go patterm of returning `nil, | ||
| err` in your `Check` and `Apply` statements. Converge will call `SetError(err)` | ||
| automatically in this case. | ||
|
|
There was a problem hiding this comment.
fyi, until #345 is merged, your error can be lost (regardless of whether you SetError or just return it) if the final plan phase HasChanges
There was a problem hiding this comment.
We'll consider that a blocker for this.
BrianHicks
force-pushed
the
feature/status-error-docs
branch
from
edb589c to
2e2830f
Compare
BrianHicks
added a commit
that referenced
this pull request
Dec 22, 2016
docs: add section on error values to resource author's guide
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.
Ping @ryane