diff options
| author | Jeff Byrnes <thejeffbyrnes@gmail.com> | 2020-10-01 16:48:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-01 16:48:14 -0400 |
| commit | 476edc4ca1923328b92e5d0e6ee981fee6035bfa (patch) | |
| tree | 33fd752c164f40be28a86a3ec9c76c679c8742c1 | |
| parent | 7241f4fbf74af995db1f632ca47953d04ec446a9 (diff) | |
docs: clarify missing info in 0.45.0 migration doc (#1714)
| -rw-r--r-- | docs/migrating-to-0.45.0/README.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/migrating-to-0.45.0/README.md b/docs/migrating-to-0.45.0/README.md index 9e70872d2..a50b7fac4 100644 --- a/docs/migrating-to-0.45.0/README.md +++ b/docs/migrating-to-0.45.0/README.md @@ -76,7 +76,7 @@ prefix = "took " [cmd_duration] # $duration – The command duration (e.g. "15s") # $style – The default style of the module (e.g. "bold yellow") -format = "took [$duration]($style)" +format = "took [$duration]($style) " ``` ### Affected Modules @@ -98,8 +98,8 @@ format = "took [$duration]($style)" -- error_symbol = "✖" -- use_symbol_for_status = true -- vicmd_symbol = "❮" -++ success_symbol = "[❯](bold green) " -++ error_symbol = "[❯](bold red) " +++ success_symbol = "[❯](bold green)" +++ error_symbol = "[❯](bold red)" ++ vicmd_symbol = "[❮](bold green)" ``` @@ -111,9 +111,11 @@ To configure the prompt to use the older `use_symbol_for_status = true` configur ```toml [character] -error_symbol = "[✖](bold red) " +error_symbol = "[✖](bold red)" ``` +*Note:* The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples. + #### Command Duration | Removed Property | Replacement | @@ -125,7 +127,7 @@ error_symbol = "[✖](bold red) " ```diff [cmd_duration] -- prefix = "took " -++ format = "took [$duration]($style)" +++ format = "took [$duration]($style) " ``` #### Directory @@ -139,7 +141,7 @@ error_symbol = "[✖](bold red) " ```diff [directory] -- prefix = "in " -++ format = "[$path]($style)[$read_only]($read_only_style)" +++ format = "[$path]($style)[$read_only]($read_only_style) " ``` #### Environment Variable @@ -189,13 +191,13 @@ error_symbol = "[✖](bold red) " -- prefix = "[" -- suffix = "]" -- show_sync_count = false -++ format = "([$all_status$ahead_behind] )" +++ format = "([$all_status$ahead_behind] ) " ``` Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch. -With the release of v0.45.0, this has been replaced with the +With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`. To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file: @@ -252,7 +254,7 @@ behind = "⇣${count}" [time] -- format = "🕙[ %T ]" ++ time_format = "%T" -++ format = "at 🕙[$time]($style) +++ format = "at 🕙[$time]($style) " ``` #### Custom Commands |