docs

Author: ataxexe

README.md

@@ -235,15 +235,22 @@ underscores.
       additional_parameters="$additional_parameters --extension=$BACKUP_EXTENSION"
     }
 
-### exists (type path)
+### exists ([type] path)
 
 Checks if the file $SODA_USER_HOME/$type/$NAMESPACE/$path exists using the namespace of the invoked
-task or imported namespace. The file path will be stored in the $FILE variable.
+task or imported namespace. The file path will be stored in the $FILE variable. If the *type* is not
+passed then **resources** will be used.
 
     exists config "my-config.conf" && {
       source $FILE
     }
 
+### resource ([type] path)
+
+Returns the file $SODA_USER_HOME/$type/$NAMESPACE/$path using the namespace of the invoked task or
+imported namespace without checking if the file exists. If the *type* is not passed then
+**resources** will be used.
+
 ### invoke (description, function_name)
 
 Invokes the given function based on user choice.
@@ -291,6 +298,19 @@ is in upper case and is already set, the prompt will be skipped.
 
     echo "$SERVER_TYPE: $SERVER_TYPE_label"
 
+### suggest (suggestion_function tasks...)
+
+Maps the given function as the bash completion function to the given tasks.
+
+### when (event_name subscribers...)
+
+Subscribe the given functions to the specified event name. The subscribers should be notified using
+the *broadcast* function.
+
+### broadcast (event_name [args...])
+
+Broadcast the event to the subscribers using the given arguments.
+
 ## Examples
 
 Check out the **examples** dir for a simple set of tasks that may help you.

scripts/core.sh

@@ -284,13 +284,13 @@ append_to_var() {
   set_var "$1" "${content}"
 }
 
-[ -z "$LOG_FILE" ] && LOG_FILE=/dev/null
-
+# Returns all namespaces
 namespaces() {
   import_all_namespaces
   echo "$NAMESPACES"
 }
 
+# Returns a resource based on the current namespace.
 resource() {
   local folder="resources"
   local filename=""
@@ -303,6 +303,7 @@ resource() {
   echo "$SODA_USER_HOME/$folder/$NAMESPACE/$filename"
 }
 
+# Checks if a resource exists based on the current namespace.
 exists() {
   FILE="$(resource "$@")"
   if [[ -f "$FILE" ]]; then
@@ -311,3 +312,5 @@ exists() {
     return 1
   fi
 }
+
+[ -z "$LOG_FILE" ] && LOG_FILE=/dev/null