mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-01 22:09:25 +00:00
general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
8edc5e9323
commit
d80e393f78
@ -1,29 +1,26 @@
|
||||
Helper
|
||||
======
|
||||
# Helper
|
||||
|
||||
Provides helper functions for developing modules.
|
||||
|
||||
Functions
|
||||
---------
|
||||
## 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.
|
||||
- `is-darwin` checks if running on macOS Darwin.
|
||||
- `is-linux` checks if running on Linux.
|
||||
- `is-bsd` checks if running on BSD.
|
||||
- `is-cygwin` checks if running on Cygwin (Windows).
|
||||
- `is-termux` checks if running on Termux (Android).
|
||||
- `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.
|
||||
- `is-darwin` checks if running on macOS Darwin.
|
||||
- `is-linux` checks if running on Linux.
|
||||
- `is-bsd` checks if running on BSD.
|
||||
- `is-cygwin` checks if running on Cygwin (Windows).
|
||||
- `is-termux` checks if running on Termux (Android).
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][1].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
Reference in New Issue
Block a user