refactor(encoder): make errors private #539
Merged
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.
After careful consideration, I decide to make sentinel errors into private errors. I don't think we can use it to take a specific action with those errors, I think it's uncommon and maybe on special case only. For example,
ErrInvalidWriter
is actually not needed since user can just check the writer before passing to the encoder. Next case isErrMissingDeveloperDataId
, users are expected to write good fit's messages, having that error does not help users to take specific action since users still need to edit fit's messages before proceeding again.