Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 11:37:32 +00:00
Code Issues Releases Activity

docs: fix wrong syntax in the format string and standardize doc tense (#1758)

Browse Source
This commit is contained in:
Mick Hohmann 2020-10-08 22:54:59 +02:00 committed by GitHub
parent a46bbf1f55
commit e7a83aa445
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/migrating-to-0.45.0/README.md
View File

@ -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` ## `prompt_order` has been replaced by a root-level `format`
Previously to v0.45.0, `prompt_order` would accept an array of module names Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship.
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** **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` Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered.
in order to stylize the way that modules are rendered.
Starship v0.45.0 will instead be accepting a `format` value, allowing for further 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.
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** **Example pre-v0.45.0 configuration**
@ -191,7 +186,7 @@ error_symbol = "[✖](bold red)"
-- prefix = "[" -- prefix = "["
-- suffix = "]" -- suffix = "]"
-- show_sync_count = false -- 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 Previously, the `show_sync_count` property was used to configure the prompt to