mart-w/serum-spec
1
0
Fork 0
mirror of https://github.com/serum-errors/serum-spec.git synced 2024-11-09 15:24:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

correct link

Browse source
This commit is contained in:
Eric Myhre 2021-12-01 14:40:47 +01:00
parent bc6b3cccfe
commit 08c5c07f2c
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -86,7 +86,7 @@ For languages that don't yet have premade libraries, see the ["In General" secti
- You can use https://github.com/serum-errors/go-serum for premade types that comply nicely with the Serum spec. - You can use https://github.com/serum-errors/go-serum for premade types that comply nicely with the Serum spec.
- You can also write your own! - You can also write your own!
- Tools: - Tools:
- See https://github.com/serum-errors/go-serum-analysis for a static analyzer which verifies Serum errors are propagated, handled, and documented accurately. - See https://github.com/serum-errors/go-serum-analyzer for a static analyzer which verifies Serum errors are propagated, handled, and documented accurately.
- Analysis uses a taint model: all possible codes that a function can return are determined; then the analyzer requires that the documentation of the function states the same set, or emits warnings about the difference. - Analysis uses a taint model: all possible codes that a function can return are determined; then the analyzer requires that the documentation of the function states the same set, or emits warnings about the difference.
- Analysis is mostly automatic and you control it by structuring your code flow to handle errors. In cases where your code is more complex than the analyzer can understand, you can manually declare changes to the expected error set on return sites, if necessary. - Analysis is mostly automatic and you control it by structuring your code flow to handle errors. In cases where your code is more complex than the analyzer can understand, you can manually declare changes to the expected error set on return sites, if necessary.
- Works with any `error` type that has a `Code() string` method -- use of the official go-serum library is in no way required! - Works with any `error` type that has a `Code() string` method -- use of the official go-serum library is in no way required!