deprecate: Error functions

Author: hyperupcall

docs/api.md

@@ -10,9 +10,6 @@ Core functions for any Bash program
 * [core.trap_remove](#coretrap_remove)
 * [core.shopt_push](#coreshopt_push)
 * [core.shopt_pop](#coreshopt_pop)
-* [core.err_set](#coreerr_set)
-* [core.err_clear](#coreerr_clear)
-* [core.err_exists](#coreerr_exists)
 * [core.panic](#corepanic)
 * [core.print_stacktrace](#coreprint_stacktrace)
 * [core.print_fatal_fn](#coreprint_fatal_fn)
@@ -25,6 +22,9 @@ Core functions for any Bash program
 * [core.print_warn](#coreprint_warn)
 * [core.print_info](#coreprint_info)
 * [core.print_debug](#coreprint_debug)
+* [core.err_set](#coreerr_set)
+* [core.err_clear](#coreerr_clear)
+* [core.err_exists](#coreerr_exists)
 * [core.should_output_color](#coreshould_output_color)
 * [core.get_package_info](#coreget_package_info)
 * [core.init](#coreinit)
@@ -104,39 +104,6 @@ core.shopt_pop
 
 _Function has no arguments._
 
-### core.err_set
-
-Sets an error.
-
-#### Arguments
-
-* **$1** (Error): code
-* **$2** (Error): message
-
-#### Variables set
-
-* **number** (ERRCODE): Error code
-* **string** (ERR): Error message
-
-### core.err_clear
-
-Clears any of the global error state (sets to empty string).
-This means any `core.err_exists` calls after this _will_ `return 1`
-
-_Function has no arguments._
-
-#### Variables set
-
-* **number** (ERRCODE): Error code
-* **string** (ERR): Error message
-
-### core.err_exists
-
-Checks if an error exists. If `ERR` is not empty, then an error
-_does_ exist
-
-_Function has no arguments._
-
 ### core.panic
 
 Use when a serious fault occurs. It will print the current ERR (if it exists)
@@ -245,6 +212,39 @@ Print a debug message to standard output if the environment variable "DEBUG" is
 
 * **$1** (string): message
 
+### core.err_set
+
+(DEPRECATED) Sets an error.
+
+#### Arguments
+
+* **$1** (Error): code
+* **$2** (Error): message
+
+#### Variables set
+
+* **number** (ERRCODE): Error code
+* **string** (ERR): Error message
+
+### core.err_clear
+
+(DEPRECATED) Clears any of the global error state (sets to empty string).
+This means any `core.err_exists` calls after this _will_ `return 1`
+
+_Function has no arguments._
+
+#### Variables set
+
+* **number** (ERRCODE): Error code
+* **string** (ERR): Error message
+
+### core.err_exists
+
+(DEPRECATED) Checks if an error exists. If `ERR` is not empty, then an error
+_does_ exist
+
+_Function has no arguments._
+
 ### core.should_output_color
 
 (DEPRECATED). Determine if color should be printed. Note that this doesn't

pkg/src/public/bash-core.sh

@@ -168,48 +168,6 @@ core.shopt_pop() {
 	___global_shopt_stack___=("${___global_shopt_stack___[@]::${#___global_shopt_stack___[@]}-2}")
 }
 
-# @description Sets an error.
-# @arg $1 Error code
-# @arg $2 Error message
-# @set number ERRCODE Error code
-# @set string ERR Error message
-core.err_set() {
-	if (($# == 1)); then
-		ERRCODE=1
-		ERR=$1
-	elif (($# == 2)); then
-		ERRCODE=$1
-		ERR=$2
-	else
-		core.panic 'Incorrect function arguments'
-	fi
-
-	if [ -z "$ERR" ]; then
-		core.panic "Argument for 'ERR' cannot be empty"
-	fi
-}
-
-# @description Clears any of the global error state (sets to empty string).
-# This means any `core.err_exists` calls after this _will_ `return 1`
-# @noargs
-# @set number ERRCODE Error code
-# @set string ERR Error message
-core.err_clear() {
-	ERRCODE=
-	ERR=
-}
-
-# @description Checks if an error exists. If `ERR` is not empty, then an error
-# _does_ exist
-# @noargs
-core.err_exists() {
-	if [ -z "$ERR" ]; then
-		return 1
-	else
-		return 0
-	fi
-}
-
 # @description Use when a serious fault occurs. It will print the current ERR (if it exists)
 core.panic() {
 	local code='1'
@@ -391,6 +349,48 @@ core.ifs_restore() {
 	IFS=$___global_ifs_variable_saved___
 }
 
+# @description (DEPRECATED) Sets an error.
+# @arg $1 Error code
+# @arg $2 Error message
+# @set number ERRCODE Error code
+# @set string ERR Error message
+core.err_set() {
+	if (($# == 1)); then
+		ERRCODE=1
+		ERR=$1
+	elif (($# == 2)); then
+		ERRCODE=$1
+		ERR=$2
+	else
+		core.panic 'Incorrect function arguments'
+	fi
+
+	if [ -z "$ERR" ]; then
+		core.panic "Argument for 'ERR' cannot be empty"
+	fi
+}
+
+# @description (DEPRECATED) Clears any of the global error state (sets to empty string).
+# This means any `core.err_exists` calls after this _will_ `return 1`
+# @noargs
+# @set number ERRCODE Error code
+# @set string ERR Error message
+core.err_clear() {
+	ERRCODE=
+	ERR=
+}
+
+# @description (DEPRECATED) Checks if an error exists. If `ERR` is not empty, then an error
+# _does_ exist
+# @noargs
+core.err_exists() {
+	if [ -z "$ERR" ]; then
+		return 1
+	else
+		return 0
+	fi
+}
+
 # @description (DEPRECATED). Determine if color should be printed. Note that this doesn't
 # use tput because simple environment variable checking heuristics suffice. Deprecated because this code
 # has been moved to bash-std