Browse Source

[Fix #249] Add documentation for helper

master
Sorin Ionescu 12 years ago
parent
commit
b48e0ed74f
  1. 12
      modules/helper/README.md
  2. 2
      modules/helper/init.zsh

12
modules/helper/README.md

@ -1,14 +1,18 @@ @@ -1,14 +1,18 @@
Trap
====
Helper
======
Provides for trapping UNIX signals and calling callback functions when a trap
is triggered.
Provides helper functions for developing modules.
Functions
---------
- `add-zsh-trap` adds a function name to a list to be called when a trap is
triggered.
- `is-autoloadable` checks if a file can be autoloaded by trying to load it
in a subshell.
- `is-callable` checks if a name is a command, function, or alias.
- `is-true` checks a boolean variable for "true".
- `coalesce` prints the first non-empty string in the arguments array.
Authors
-------

2
modules/helper/init.zsh

@ -10,7 +10,7 @@ function is-autoloadable { @@ -10,7 +10,7 @@ function is-autoloadable {
( unfunction $1 ; autoload -U +X $1 ) &> /dev/null
}
# Checks a name if it is a command, function, or alias.
# Checks if a name is a command, function, or alias.
function is-callable {
(( $+commands[$1] )) || (( $+functions[$1] )) || (( $+aliases[$1] ))
}

Loading…
Cancel
Save