diff options
| author | Mick Hohmann <micck@users.noreply.github.com> | 2020-10-08 22:54:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-08 16:54:59 -0400 |
| commit | e7a83aa445a6b48cde05b51a30e19d02042ca0b0 (patch) | |
| tree | aac45b1d002b64299f2e08cad5106cbb94f15492 /docs | |
| parent | a46bbf1f55f18eefd855e34e76c0c6b779ce2f5d (diff) | |
docs: fix wrong syntax in the format string and standardize doc tense (#1758)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/migrating-to-0.45.0/README.md | 17 |
1 files changed, 6 insertions, 11 deletions
diff --git a/docs/migrating-to-0.45.0/README.md b/docs/migrating-to-0.45.0/README.md index a50b7fac4..1e484a609 100644 --- a/docs/migrating-to-0.45.0/README.md +++ b/docs/migrating-to-0.45.0/README.md @@ -6,10 +6,9 @@ This guide is intended to walk you through the breaking changes. ## `prompt_order` has been replaced by a root-level `format` -Previously to v0.45.0, `prompt_order` would accept an array of module names -in the order which they should be rendered by Starship. +Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship. -Starship v0.45.0 will instead be accepting a `format` value, allowing for customization of the prompt outside of the modules themselves. +Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves. **Example pre-v0.45.0 configuration** @@ -53,15 +52,11 @@ format = """\ """ ``` -## Module `prefix` and `suffix` will be replaced by `format` +## Module `prefix` and `suffix` have been replaced by `format` -Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` -in order to stylize the way that modules are rendered. +Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered. -Starship v0.45.0 will instead be accepting a `format` value, allowing for further -customization of how modules are rendered. Instead of defining a prefix and suffix -for the context-based variables, the variables can now be substituted from within -a format string, which represents the module's output. +Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output. **Example pre-v0.45.0 configuration** @@ -191,7 +186,7 @@ error_symbol = "[✖](bold red)" -- prefix = "[" -- suffix = "]" -- show_sync_count = false -++ format = "([$all_status$ahead_behind] ) " +++ format = "[\\[$all_status$ahead_behind\\]]($style)" ``` Previously, the `show_sync_count` property was used to configure the prompt to |