From 76d1918dca288847ef4d696034af33d57936e54e Mon Sep 17 00:00:00 2001 From: Marko Date: Mon, 25 Sep 2023 15:13:38 +0200 Subject: [PATCH] docs: add a readme to the types/errors package (#17867) --- types/errors/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 types/errors/README.md diff --git a/types/errors/README.md b/types/errors/README.md new file mode 100644 index 000000000000..e2ff4e4fd20a --- /dev/null +++ b/types/errors/README.md @@ -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).