mirror of
https://github.com/octoleo/hosts.git
synced 2024-11-21 20:35:10 +00:00
Use consistent terminology in function documentation.
GH-9
This commit is contained in:
parent
2f5f610e3c
commit
5112c3e6a0
16
hosts
16
hosts
@ -253,7 +253,7 @@ _main() {
|
||||
# Usage:
|
||||
# _function_exists "possible_function_name"
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If a function with the given name is defined in the current environment.
|
||||
# 1 If not.
|
||||
#
|
||||
@ -268,7 +268,7 @@ _function_exists() {
|
||||
# Usage:
|
||||
# _command_exists "possible_command_name"
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If a command with the given name is defined in the current environment.
|
||||
# 1 If not.
|
||||
#
|
||||
@ -283,7 +283,7 @@ _command_exists() {
|
||||
# Usage:
|
||||
# _contains "$item" "${list[*]}"
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If the item is included in the list.
|
||||
# 1 If not.
|
||||
_contains() {
|
||||
@ -323,7 +323,7 @@ _join() {
|
||||
# Usage:
|
||||
# _command_argv_includes "an_argument"
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If the argument is included in `$_COMMAND_ARGV`, the program's command
|
||||
# argument list.
|
||||
# 1 If not.
|
||||
@ -339,7 +339,7 @@ _command_argv_includes() {
|
||||
# Usage:
|
||||
# _blank "$an_argument"
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If the argument is not present or null.
|
||||
# 1 If the argument is present and not null.
|
||||
_blank() {
|
||||
@ -351,7 +351,7 @@ _blank() {
|
||||
# Usage:
|
||||
# _present "$an_argument"
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If the argument is present and not null.
|
||||
# 1 If the argument is not present or null.
|
||||
_present() {
|
||||
@ -363,7 +363,7 @@ _present() {
|
||||
# Usage:
|
||||
# _interactive_input
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If the current input is interactive (eg, a shell).
|
||||
# 1 If the current input is stdin / piped input.
|
||||
_interactive_input() {
|
||||
@ -375,7 +375,7 @@ _interactive_input() {
|
||||
# Usage:
|
||||
# _piped_input
|
||||
#
|
||||
# Returns:
|
||||
# Exit Status:
|
||||
# 0 If the current input is stdin / piped input.
|
||||
# 1 If the current input is interactive (eg, a shell).
|
||||
_piped_input() {
|
||||
|
Loading…
Reference in New Issue
Block a user