From f9dcbf3e8b10ab1646b246c5d010c1a079c520ea Mon Sep 17 00:00:00 2001 From: gluax <16431709+gluax@users.noreply.github.com> Date: Wed, 20 Apr 2022 11:06:40 -0700 Subject: [PATCH] update leo errors readme --- leo/errors/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/leo/errors/README.md b/leo/errors/README.md index edfd180bff..0a0c4aa726 100644 --- a/leo/errors/README.md +++ b/leo/errors/README.md @@ -6,6 +6,15 @@ This directory contains the code for the Errors for all the Leo crates. +The errors are inspired by `rust` in a few different ways: + +- Each error has its own unique code. +- Error codes will never be changed upon a stable release. + - Meaning outdated errors will just deprecated. +- In addition we had a unique identifier to let you know where the compiler found the error. + +The purpose of these errors is such that searching an error in the documentation, or online for help, becomes easier. + ## [Common](./src/common) The common section of this crate contains a few sub files: