From 010a1e4dac0d7e43a0e85e9c67d57414ee466260 Mon Sep 17 00:00:00 2001
From: Milos Gligoric <milos.gligoric@gmail.com>
Date: Wed, 31 Jan 2024 15:58:27 -0600
Subject: [PATCH] doc: Include documentation for several sys functions

---
 src/lang/sys.sh | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/src/lang/sys.sh b/src/lang/sys.sh
index 0ebe9f7..a9fa927 100644
--- a/src/lang/sys.sh
+++ b/src/lang/sys.sh
@@ -20,7 +20,10 @@ readonly SYS_SUFFIX="-dev"
 # Functions.
 
 function sys_version() {
-        # Version.
+        # Return gobash version.
+        # 
+        # :return: gobash version.
+        # :rtype: string
         local ctx; is_ctx "${1}" && ctx="${1}" && shift
         [ $# -ne 0 ] && { ctx_wn $ctx; return $EC; }
         shift 0 || { ctx_wn $ctx; return $EC; }
@@ -30,6 +33,9 @@ function sys_version() {
 
 function sys_repo_path() {
         # Root dir for this repo.
+        # 
+        # :return: root directory for this repository.
+        # :rtype: string
         local ctx; is_ctx "${1}" && ctx="${1}" && shift
         [ $# -ne 0 ] && { ctx_wn $ctx; return $EC; }
         shift 0 || { ctx_wn $ctx; return $EC; }
@@ -39,6 +45,9 @@ function sys_repo_path() {
 
 function sys_stack_trace() {
         # Print stack trace.
+        # 
+        # :return: stack trace.
+        # :rtype: strings
         local ctx; is_ctx "${1}" && ctx="${1}" && shift
         [ $# -ne 0 ] && { ctx_wn $ctx; return $EC; }
         shift 0 || { ctx_wn $ctx; return $EC; }