Skip to content

Commit 1b4454f

Browse files
authored
clean: One pass over code and docs to do cleaning (#19)
1 parent 5e7da53 commit 1b4454f

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

doc/index.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
gobash documentation
33
====================
44

5-
gobash is a set of bash functions that improve programming experience
6-
in bash (by providing collections, languages features, APIs, testing
7-
package, command line flag parsing, etc.) without modifying the shell
8-
interpreter(s). It works with any bash version (on Linux and
9-
Mac). Parts of the API match those in Go.
5+
gobash, a self-proclaimed standard bash library, is a set of bash
6+
functions that improve programming experience in bash (by providing
7+
collections, languages features, APIs, testing package, command line
8+
flag parsing, etc.) without modifying the shell interpreter(s). It
9+
works with any bash version (on Linux and Mac). Parts of the API match
10+
those in Go.
1011

1112
gobash is publicly available on `GitHub
1213
<https://github.com/EngineeringSoftware/gobash>`_ under the

doc/language.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,14 +159,12 @@ method that computes its total area.
159159
160160
make_ $FUNCNAME \
161161
"r" "${r}"
162-
return $?
163162
}
164163
165164
function Circle_area() {
166-
local -r obj="${1}"
165+
local -r c="${1}"
167166
168-
echo "$MATH_PI * $($obj r) * $($obj r)" | bc
169-
return 0
167+
echo "$MATH_PI * $($c r) * $($c r)" | bc
170168
}
171169
172170
Invoking a method is similar to other programming languages. Below, we
@@ -214,8 +212,8 @@ only the name of the person.
214212
.. code-block:: bash
215213
216214
function Person_to_string() {
217-
local -r obj="${1}"
218-
echo "I am $($obj name)."
215+
local -r p="${1}"
216+
echo "I am $($p name)."
219217
}
220218
p=$(Person "Jessy" 10)
221219
$p to_string

src/ui/textui.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ function TextSpinner() {
7979

8080
make_ $ctx \
8181
"${FUNCNAME}" \
82-
"ix" "0" \
8382
"pid" "${NULL}"
8483
}
8584

0 commit comments

Comments
 (0)