More updates to docs

[reubeno]

No description provided.

[github-actions]

Test Results

381 tests   364 ✅  2m 46s ⏱️
 63 suites   17 💤
  8 files      0 ❌

Results for commit 11c991d.

[github-actions]

Performance Benchmark Report

Benchmark name	Baseline (ns)	Test/PR (ns)	Delta (ns)	Delta %
expand_one_string	3450 ns	3448 ns	-2 ns	🟢 -0.06%
instantiate_shell	61108 ns	61071 ns	-37 ns	🟢 -0.06%
instantiate_shell_with_init_scripts	27532842 ns	28670838 ns	+1137996 ns	🟠 +4.13%
parse_bash_completion	5722576 ns	5816792 ns	+94216 ns	🟠 +1.65%
parse_sample_script	9010 ns	9113 ns	+103 ns	🟠 +1.14%
run_echo_builtin_command	99862 ns	98741 ns	-1121 ns	🟢 -1.12%
run_one_builtin_command	117743 ns	118790 ns	+1047 ns	🟠 +0.89%
run_one_external_command	1858197 ns	1917544 ns	+59347 ns	🟠 +3.19%
run_one_external_command_directly	1026680 ns	1033199 ns	+6519 ns	🟠 +0.63%

Code Coverage Report

Package	Base Coverage	New Coverage	Difference
/home/runner/work/brush/brush/cli/src/main.rs	🟠 71.63%	🟠 71.63%	⚪ 0%
/home/runner/work/brush/brush/interactive-shell/src/interactive_shell.rs	🟢 75.77%	🟢 75.77%	⚪ 0%
/home/runner/work/brush/brush/parser/src/arithmetic.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/parser/src/ast.rs	🔴 29.36%	🔴 29.36%	⚪ 0%
/home/runner/work/brush/brush/parser/src/error.rs	🟢 83.33%	🟢 83.33%	⚪ 0%
/home/runner/work/brush/brush/parser/src/parser.rs	🟢 98.65%	🟢 98.65%	⚪ 0%
/home/runner/work/brush/brush/parser/src/pattern.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/parser/src/prompt.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/parser/src/test_command.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/parser/src/tokenizer.rs	🟢 95.5%	🟢 95.5%	⚪ 0%
/home/runner/work/brush/brush/parser/src/word.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/arithmetic.rs	🟢 97.03%	🟢 97.03%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtin.rs	🔴 32.12%	🔴 32.12%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/alias.rs	🟢 83.87%	🟢 83.87%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/bg.rs	🔴 0%	🔴 0%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/break_.rs	🟢 90%	🟢 90%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/builtin_.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/cd.rs	🟢 88.57%	🟢 88.57%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/colon.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/complete.rs	🔴 21.48%	🔴 21.48%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/continue_.rs	🟢 90%	🟢 90%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/declare.rs	🟢 82.78%	🟢 82.78%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/dirs.rs	🟢 90.48%	🟢 90.48%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/dot.rs	🟢 95.65%	🟢 95.65%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/echo.rs	🟢 86.11%	🟢 86.11%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/enable.rs	🟢 91.07%	🟢 91.07%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/eval.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/exec.rs	🟢 91.43%	🟢 91.43%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/exit.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/export.rs	🟢 88.73%	🟢 88.73%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/false_.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/fg.rs	🔴 0%	🔴 0%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/getopts.rs	🟢 97.7%	🟢 97.7%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/help.rs	🟢 92.86%	🟢 92.86%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/jobs.rs	🟢 81.25%	🟢 81.25%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/kill.rs	🔴 0%	🔴 0%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/let_.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/mod.rs	🟢 94.61%	🟢 94.61%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/popd.rs	🟢 94.12%	🟢 94.12%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/printf.rs	🟢 96.77%	🟢 96.77%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/pushd.rs	🟢 91.3%	🟢 91.3%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/pwd.rs	🟢 89.47%	🟢 89.47%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/read.rs	🟢 96.1%	🟢 96.1%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/return_.rs	🟢 83.33%	🟢 83.33%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/set.rs	🟠 70.8%	🟠 70.8%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/shift.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/shopt.rs	🟢 88.39%	🟢 88.39%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/test.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/trap.rs	🟢 81.72%	🟢 81.72%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/true_.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/type_.rs	🟢 90.27%	🟢 90.27%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/umask.rs	🔴 0%	🔴 0%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/unalias.rs	🔴 0%	🔴 0%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/unimp.rs	🔴 0%	🔴 0%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/unset.rs	🟢 94.64%	🟢 94.64%	⚪ 0%
/home/runner/work/brush/brush/shell/src/builtins/wait.rs	🟢 85.71%	🟢 85.71%	⚪ 0%
/home/runner/work/brush/brush/shell/src/commands.rs	🟢 92.96%	🟢 92.96%	⚪ 0%
/home/runner/work/brush/brush/shell/src/completion.rs	🔴 43.25%	🔴 43.25%	⚪ 0%
/home/runner/work/brush/brush/shell/src/context.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/env.rs	🟢 87.85%	🟢 87.85%	⚪ 0%
/home/runner/work/brush/brush/shell/src/error.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/escape.rs	🔴 14.91%	🔴 14.91%	⚪ 0%
/home/runner/work/brush/brush/shell/src/expansion.rs	🟢 97.24%	🟢 97.24%	⚪ 0%
/home/runner/work/brush/brush/shell/src/extendedtests.rs	🟠 66.38%	🟠 66.38%	⚪ 0%
/home/runner/work/brush/brush/shell/src/functions.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/interp.rs	🟢 92.74%	🟢 92.74%	⚪ 0%
/home/runner/work/brush/brush/shell/src/jobs.rs	🔴 39.38%	🔴 39.38%	⚪ 0%
/home/runner/work/brush/brush/shell/src/keywords.rs	🟢 96.88%	🟢 96.88%	⚪ 0%
/home/runner/work/brush/brush/shell/src/namedoptions.rs	🟠 52.09%	🟠 52.09%	⚪ 0%
/home/runner/work/brush/brush/shell/src/openfiles.rs	🟠 51.82%	🟠 51.82%	⚪ 0%
/home/runner/work/brush/brush/shell/src/options.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/patterns.rs	🟢 96.92%	🟢 96.92%	⚪ 0%
/home/runner/work/brush/brush/shell/src/prompt.rs	🟢 78.48%	🟢 78.48%	⚪ 0%
/home/runner/work/brush/brush/shell/src/regex.rs	🟢 100%	🟢 100%	⚪ 0%
/home/runner/work/brush/brush/shell/src/shell.rs	🟢 78.6%	🟢 78.6%	⚪ 0%
/home/runner/work/brush/brush/shell/src/tests.rs	🟠 50%	🟠 50%	⚪ 0%
/home/runner/work/brush/brush/shell/src/traps.rs	🟠 50%	🟠 50%	⚪ 0%
/home/runner/work/brush/brush/shell/src/users.rs	🔴 20%	🔴 20%	⚪ 0%
/home/runner/work/brush/brush/shell/src/variables.rs	🟢 79.39%	🟢 79.39%	⚪ 0%
Overall Coverage	🟢 78.67%	🟢 78.67%	⚪ 0%

Minimum allowed coverage is 0%, this run produced 78.67%