shitload of links to docs

Author: lainio

assert/doc.go

@@ -47,7 +47,7 @@ raise up quality of our software.
 The assert package offers a convenient way to set preconditions to code which
 allow us detect programming errors and API violations faster. Still allowing
 production-time error handling if needed. And everything is automatic. You can
-set asserter with SetDefault function or --asserter flag if Go's flag package is
+set asserter with [SetDefault] function or --asserter flag if Go's flag package is
 in use. This allows developer, operator and every-day user share the exact same
 binary but get the error messages and diagnostic they need.
 
@@ -73,7 +73,7 @@ And assert package's configuration flags are inserted.
 assert.That's performance is equal to the if-statement thanks for inlining. And
 the most of the generics-based versions are about the equally fast. Practice has
 thought that we should prefer other than assert.That because by using detailed
-version like assert.Shorter we get precise error messages automatically. Some
+version like [assert.Shorter] we get precise error messages automatically. Some
 also prefer readability of specific asserters.
 
 If your algorithm is performance-critical please run `make bench` in the err2

doc.go

@@ -50,7 +50,7 @@ them. The CopyFile example shows how it works:
 
 # Error checks and Automatic Error Propagation
 
-The try package provides convenient helpers to check the errors. For example,
+The [github.com/lainio/err2/try] package provides convenient helpers to check the errors. For example,
 instead of
 
 	b, err := io.ReadAll(r)
@@ -94,7 +94,7 @@ tracer API:
 
 # Flag Package Support
 
-The err2 package supports Go's flags. All you need to do is to call flag.Parse.
+The err2 package supports Go's flags. All you need to do is to call [flag.Parse].
 And the following flags are supported (="default-value"):
 
 	-err2-log="nil"
@@ -105,7 +105,7 @@ And the following flags are supported (="default-value"):
 	    A name of the stream currently supported stderr, stdout or nil
 
 Note, that you have called [SetErrorTracer] and others, before you call
-flag.Parse. This allows you set the defaults according your app's need and allow
+[flag.Parse]. This allows you set the defaults according your app's need and allow
 end-user change them during the runtime.
 
 # Error handling

err2.go

@@ -20,8 +20,9 @@ type (
 // [ErrNotFound] ... [ErrNotEnabled] are similar no-error like [io.EOF] for
 // those who really want to use error return values to transport non errors.
 // It's far better to have discriminated unions as errors for function calls.
-// But if you insist the related helpers are in they [try] package:
-// try.IsNotFound, ...
+// But if you insist the related helpers are in they
+// [github.com/lainio/err2/try] package:
+// [github.com/lainio/err2/try.IsNotFound], ...
 //
 // [ErrRecoverable] and [ErrNotRecoverable] since Go 1.20 wraps multiple errors
 // same time, i.e. wrapped errors aren't list anymore but tree. This allows mark
@@ -60,9 +61,9 @@ var Stdnull = &nullDev{}
 //
 // Note. If you are still using sentinel errors you must be careful with the
 // automatic error annotation because it uses wrapping. If you must keep the
-// error value got from error checks: [try.To], you must disable automatic
-// error annotation (%w), or set the returned error values in the handler
-// function. Disabling can be done by setting second argument nil:
+// error value got from error checks: [github.com/lainio/err2/try.To], you must
+// disable automatic error annotation (%w), or set the returned error values in
+// the handler function. Disabling can be done by setting second argument nil:
 //
 //	func SaveData(...) (err error) {
 //	     defer err2.Handle(&err, nil) // nil arg disable automatic annotation.
@@ -183,7 +184,7 @@ func Catch(a ...any) {
 }
 
 // Throwf builds and throws (panics) an error. For creation it's similar to
-// fmt.Errorf. Because panic is used to transport the error instead of error
+// [fmt.Errorf]. Because panic is used to transport the error instead of error
 // return value, it's called only if you want to non-local control structure for
 // error handling, i.e. your current function doesn't have error return value.
 //

handlers.go

@@ -8,7 +8,7 @@ import (
 )
 
 // Stderr is a built-in helper to use with [Handle] and [Catch]. It prints the
-// error to stderr and it resets the current error value. It's a handy Catch
+// error to stderr and it resets the current error value. It's a handy [Catch]
 // handler in main function.
 //
 // You can use it like this:
@@ -23,8 +23,8 @@ func Stderr(err error) error {
 	return nil
 }
 
-// Stdout is a built-in helper to use with Handle and Catch. It prints the
-// error to stdout and it resets the current error value. It's a handy Catch
+// Stdout is a built-in helper to use with [Handle] and [Catch]. It prints the
+// error to stdout and it resets the current error value. It's a handy [Catch]
 // handler in main function.
 //
 // You can use it like this:
@@ -39,13 +39,13 @@ func Stdout(err error) error {
 	return nil
 }
 
-// Noop is a built-in helper to use with Handle and Catch. It keeps the current
+// Noop is a built-in helper to use with [Handle] and [Catch]. It keeps the current
 // error value the same. You can use it like this:
 //
 //	defer err2.Handle(&err, err2.Noop)
 func Noop(err error) error { return err }
 
-// Reset is a built-in helper to use with Handle and Catch. It sets the current
+// Reset is a built-in helper to use with [Handle] and [Catch]. It sets the current
 // error value to nil. You can use it like this to reset the error:
 //
 //	defer err2.Handle(&err, err2.Reset)
@@ -60,7 +60,7 @@ func Reset(error) error { return nil }
 //		fmt.Println("ERROR:", err)
 //	}))
 //
-// Note, that since Err helper we have other helpers like Stdout that allows
+// Note, that since Err helper we have other helpers like [Stdout] that allows
 // previous block be written as simple as:
 //
 //	defer err2.Catch(err2.Stdout)

tracer.go

@@ -6,75 +6,75 @@ import (
 	"github.com/lainio/err2/internal/tracer"
 )
 
-// ErrorTracer returns current io.Writer for automatic error stack tracing.
+// ErrorTracer returns current [io.Writer] for automatic error stack tracing.
 // The default value is nil.
 func ErrorTracer() io.Writer {
 	return tracer.Error.Tracer()
 }
 
-// PanicTracer returns current io.Writer for automatic panic stack tracing. Note
-// that runtime.Error types which are transported by panics are controlled by
-// this. The default value is os.Stderr.
+// PanicTracer returns current [io.Writer] for automatic panic stack tracing. Note
+// that [runtime.Error] types which are transported by panics are controlled by
+// this. The default value is [os.Stderr].
 func PanicTracer() io.Writer {
 	return tracer.Panic.Tracer()
 }
 
-// LogTracer returns a current io.Writer for the explicit try.Result.Logf
-// function and automatic logging used in err2.Handle and err2.Catch. The
+// LogTracer returns a current [io.Writer] for the explicit [try.Result.Logf]
+// function and automatic logging used in [Handle] and [Catch]. The
 // default value is nil.
 func LogTracer() io.Writer {
 	return tracer.Log.Tracer()
 }
 
-// SetErrorTracer sets a io.Writer for automatic error stack tracing. The err2
+// SetErrorTracer sets a [io.Writer] for automatic error stack tracing. The err2
 // default is nil. Note that the current function is capable to print error
 // stack trace when the function has at least one deferred error handler, e.g:
 //
 //	func CopyFile(src, dst string) (err error) {
 //	     defer err2.Handle(&err) // <- error trace print decision is done here
 //
-// Remember that you can reset these with Flag package support. See
+// Remember that you can reset these with [flag] package support. See
 // documentation of err2 package's flag section.
 func SetErrorTracer(w io.Writer) {
 	tracer.Error.SetTracer(w)
 }
 
-// SetPanicTracer sets a io.Writer for automatic panic stack tracing. The err2
-// default is os.Stderr. Note that runtime.Error types which are transported by
+// SetPanicTracer sets a [io.Writer] for automatic panic stack tracing. The err2
+// default is [os.Stderr]. Note that [runtime.Error] types which are transported by
 // panics are controlled by this. Note also that the current function is capable
 // to print panic stack trace when the function has at least one deferred error
 // handler, e.g:
 //
 //	func CopyFile(src, dst string) (err error) {
 //	     defer err2.Handle(&err) // <- panic trace print decision is done here
 //
-// Remember that you can reset these with Flag package support. See
+// Remember that you can reset these with [flag] package support. See
 // documentation of err2 package's flag section.
 func SetPanicTracer(w io.Writer) {
 	tracer.Panic.SetTracer(w)
 }
 
-// SetLogTracer sets a current io.Writer for the explicit try.Result.Logf
-// function and automatic logging used in err2.Handle and err2.Catch. The
+// SetLogTracer sets a current [io.Writer] for the explicit [try.Result.Logf]
+// function and automatic logging used in [Handle] and [Catch]. The
 // default is nil and then err2 uses std log package for logging.
 //
-// You can use the std log package to redirect other logging packages like glog
-// to automatically work with the err2 package. For the glog, add this line at
+// You can use the std log package to redirect other logging packages like [glog]
+// to automatically work with the err2 package. For the [glog], add this line at
 // the beginning of your app:
 //
 //	glog.CopyStandardLogTo("INFO")
 //
-// Remember that you can reset these with Flag package support. See
+// Remember that you can reset these with [flag] package support. See
 // documentation of err2 package's flag section.
 func SetLogTracer(w io.Writer) {
 	tracer.Log.SetTracer(w)
 }
 
-// SetTracers a helper to set a io.Writer for error and panic stack tracing, the
-// log tracer is set as well. More information see SetErrorTracer,
-// SetPanicTracer, and SetLogTracer functions.
+// SetTracers a helper to set a [io.Writer] for error and panic stack tracing, the
+// log tracer is set as well. More information see [SetErrorTracer],
+// [SetPanicTracer], and [SetLogTracer] functions.
 //
-// Remember that you can reset these with Flag package support. See
+// Remember that you can reset these with [flag] package support. See
 // documentation of err2 package's flag section.
 func SetTracers(w io.Writer) {
 	tracer.Error.SetTracer(w)