From 1500717004e235d556d7495c0c59df1fdeed5982 Mon Sep 17 00:00:00 2001 From: Sorin Ionescu Date: Tue, 12 Jun 2012 15:35:47 -0400 Subject: [PATCH] [Fix #120] Add documentation for trap --- modules/trap/README.md | 21 +++++++++++++++++++++ modules/trap/functions/add-zsh-trap | 4 ++-- 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 modules/trap/README.md diff --git a/modules/trap/README.md b/modules/trap/README.md new file mode 100644 index 0000000..97763c0 --- /dev/null +++ b/modules/trap/README.md @@ -0,0 +1,21 @@ +Trap +==== + +Provides for trapping UNIX signals and calling callback functions when a trap +is triggered. + +Functions +--------- + + - `add-zsh-trap` adds a function name to a list to be called when a trap is + triggered. + +Authors +------- + +*The authors of this module should be contacted via the [issue tracker][1].* + + - [Sorin Ionescu](https://github.com/sorin-ionescu) + +[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues + diff --git a/modules/trap/functions/add-zsh-trap b/modules/trap/functions/add-zsh-trap index a147c68..e5d4e82 100644 --- a/modules/trap/functions/add-zsh-trap +++ b/modules/trap/functions/add-zsh-trap @@ -1,6 +1,6 @@ # -# Provides for the trapping of UNIX signals and the calling of multiple -# registered functions when a trap is triggered. +# Provides for trapping UNIX signals and calling callback functions when a trap +# is triggered. # # Authors: # Sorin Ionescu