summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZhizhen He <hezhizhen.yi@gmail.com>2023-02-07 19:52:41 +0800
committerGitHub <noreply@github.com>2023-02-07 12:52:41 +0100
commitf6c9fd53482d170f025366068e8667a484b9dbe9 (patch)
tree9344c8addb03a3892d3cc2f98f49c066f2e164bc
parentc0196306539a7558445499fc68befb2750c44454 (diff)
docs: fix typos (#4889)
-rw-r--r--docs/config/README.md30
-rw-r--r--docs/faq/README.md2
2 files changed, 16 insertions, 16 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 2f9a02e79..db70a2beb 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -46,7 +46,7 @@ os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\star
### Logging
-By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal.
+By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal.
This, however can be changed using the `STARSHIP_CACHE` environment variable:
```sh
@@ -1144,7 +1144,7 @@ prefixes or development directories (i.e. Java). Note that this will disable the
`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero,
the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path
-`/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as
+`/built/this/city/on/rock/and/roll`, which would normally be displayed as `rock/and/roll`, would be displayed as
`/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with
a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -3869,18 +3869,18 @@ To enable it, set `disabled` to `false` in your configuration file.
### Variables
-| Variable | Example | Description |
-| -------------- | ------- | ------------------------------------------------------------------------------------------- |
-| status | `127` | The exit code of the last command |
-| hex_status | `0x7F` | The exit code of the last command in hex |
-| int | `127` | The exit code of the last command |
-| common_meaning | `ERROR` | Meaning of the code if not a signal |
-| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
-| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
-| maybe_int | `7` | Contains the exit code number when no meaning has been found |
-| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| -------------- | ------- | ------------------------------------------------------------------------------------------ |
+| status | `127` | The exit code of the last command |
+| hex_status | `0x7F` | The exit code of the last command in hex |
+| int | `127` | The exit code of the last command |
+| common_meaning | `ERROR` | Meaning of the code if not a signal |
+| signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
+| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
+| maybe_int | `7` | Contains the exit code number when no meaning has been found |
+| pipestatus | | Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format |
+| symbol | | Mirrors the value of option `symbol` |
+| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
@@ -4257,7 +4257,7 @@ format = '[🆅 $repo](bold blue) '
## Zig
-By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/).
+By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/).
The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file
diff --git a/docs/faq/README.md b/docs/faq/README.md
index 4cab4eb2f..98ceb0ba6 100644
--- a/docs/faq/README.md
+++ b/docs/faq/README.md
@@ -96,7 +96,7 @@ This will output the trace log and a breakdown of all modules that either took
more than 1ms to execute or produced some output.
Finally if you find a bug you can use the `bug-report` command to create a
-Github issue.
+GitHub issue.
```sh
starship bug-report