docs: add a readme to the types/errors package (#17867)

This commit is contained in:
Marko 2023-09-25 15:13:38 +02:00 committed by GitHub
parent 150013ee50
commit 76d1918dca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

9
types/errors/README.md Normal file
View File

@ -0,0 +1,9 @@
# Errors
:::note
this package is deprecated, users should use "cosmossdk.io/errors" instead.
:::
Errors is a package that was deprecated but still contains error types. These error types are meant to be used by the Cosmos SDK to define error types. It is recommended that modules define their own error types, even if it is a duplicate of errors in this package. This will allow developers to more easily debug module errors and separate them from Cosmos SDK errors.
For this package's documentation, please see the [go documentation](https://pkg.go.dev/github.com/cosmos/cosmos-sdk@v0.47.5/types/errors).