forked from TrueCloudLab/frostfs-node
[#1247] *: Clarify docs about returned errors from apistatus
package
`apistatus` package provides types which implement build-in `error` interface. Add `error of type` pattern when documenting these errors in order to clarify how these errors should be handled (e.g. `errors.Is` is not good). Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
parent
459bdcf04b
commit
318639e5bf
24 changed files with 33 additions and 33 deletions
|
@ -19,7 +19,7 @@ type GetSmallRes struct {
|
|||
// Returns any error encountered that
|
||||
// did not allow to completely read the object.
|
||||
//
|
||||
// Returns apistatus.ObjectNotFound if requested object is missing in blobovnicza(s).
|
||||
// Returns an error of type apistatus.ObjectNotFound if requested object is missing in blobovnicza(s).
|
||||
func (b *BlobStor) GetSmall(prm *GetSmallPrm) (*GetSmallRes, error) {
|
||||
return b.blobovniczas.get(prm)
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue