mirror of
https://github.com/tomasriveral/NoteWrapper.git
synced 2026-08-12 02:18:38 +02:00
Documentation: Reworked debug and error handling information in CONTRIBUTING.md
This commit is contained in:
+2
-2
@@ -8,7 +8,7 @@ This project aims to remain minimal, terminal-focused, and easy to extend. Contr
|
|||||||
|
|
||||||
## Debugging and error handling
|
## Debugging and error handling
|
||||||
|
|
||||||
Please use the standardized debugging and error-handling functions:
|
Please use the standardized debugging and error-handling functions defined in [/src/utils.c](./src/utils.c):
|
||||||
|
|
||||||
* `debug(...)`
|
* `debug(...)`
|
||||||
Used for formatted debugging output (printf-style formatting).
|
Used for formatted debugging output (printf-style formatting).
|
||||||
@@ -17,7 +17,7 @@ Please use the standardized debugging and error-handling functions:
|
|||||||
A lighter version of `debug()` when full formatting is not required.
|
A lighter version of `debug()` when full formatting is not required.
|
||||||
|
|
||||||
* `error(condition, "user" | "program", "error message", ...)`
|
* `error(condition, "user" | "program", "error message", ...)`
|
||||||
Standard error reporting function:
|
Standard error reporting function (printf-style formatting):
|
||||||
|
|
||||||
* `"user"`: errors caused by user input or configuration
|
* `"user"`: errors caused by user input or configuration
|
||||||
* `"program"`: internal or unexpected program errors
|
* `"program"`: internal or unexpected program errors
|
||||||
|
|||||||
Reference in New Issue
Block a user