[#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:
Leonard Lyubich 2022-03-17 16:26:17 +03:00 committed by Alex Vanin
parent 459bdcf04b
commit 318639e5bf
24 changed files with 33 additions and 33 deletions

View file

@ -15,7 +15,7 @@ type Source interface {
// It returns the pointer to requested container and any error encountered.
//
// Get must return exactly one non-nil value.
// Get must return apistatus.ContainerNotFound if the container is not in storage.
// Get must return an error of type apistatus.ContainerNotFound if the container is not in storage.
//
// Implementations must not retain the container pointer and modify
// the container through it.