From b6f12b7acfb418dd398b5741773d421a279f1cae Mon Sep 17 00:00:00 2001 From: mstar Date: Wed, 2 Apr 2025 13:45:54 +0200 Subject: [PATCH] Update code style --- Code-Style.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Code-Style.md b/Code-Style.md index 344e2a8..e4cd520 100644 --- a/Code-Style.md +++ b/Code-Style.md @@ -12,9 +12,11 @@ - Always use zerolog for console output. In http handlers, use `hlog.FromRequest` to get a logger instance prepared with a bunch of metadata - As Linstrom is both intended for active use as well as providing a learning resource, - all functions and structs must be documented -- Errors returned from public functions must be wrapped with `git.mstar.dev/mstar/goutils/other.Error` + all functions and structs must be documented and follow the conventions on [https://tip.golang.org/doc/comment] +- Errors returned from public functions must either be wrapped with `git.mstar.dev/mstar/goutils/other.Error` and given appropriate descriptive information + _or_ return an error defined (as public variable) in that package. + Example: `other.Error("auth", "failed to do something important", originalError)` ## JS/TS