fix: Standarize/disambiguate return from Parse
#77
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.
problem:
digest.Parse
(prototypefunc Parse(string) (Digest, error)
), returns the tuple(Digest, error)
. The expected behavior of a function in Golang that returns such, i.e.,(Object, error)
, is that either returns(<something>, nil)
(form A), or otherwise(<nothing>, <error>)
(form B)--but not(<something>, <error>)
(form C). This is, however, what this function does.This is a very minor fix, since it is also expected that callers first pay attention to the error returned, before looking at the datum. And so, we can drop this PR if people deem it unnecessary. When I first made this change, it was because I came across a use case in
oras-go
where the caller ended up using the datum despite an error, which has now been corrected.change: Make it return one of the two valid forms (forms A and B), and not the third (form C).
cc: @AkihiroSuda, @thaJeztah
supersedes: #76