Skip to content

Commit

Permalink
docs: unify language segment docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tillig authored and JanDeDobbeleer committed Jan 22, 2021
1 parent 2af3e67 commit cdc9ff9
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 6 deletions.
5 changes: 4 additions & 1 deletion docs/docs/segment-dotnet.md
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Dotnet

## What

Display the currently active .NET SDK version.
Display the currently active .NET SDK version when a folder contains .NET files.

## Sample Configuration

Expand All @@ -28,5 +28,8 @@ Display the currently active .NET SDK version.
- display_version: `boolean` - display the active version or not; useful if all you need is an icon indicating `dotnet`
is present - defaults to `true`
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: The segment is always displayed
- `files`: The segment is only displayed when `*.cs`, `*.vb`, `*.sln`, `*.csproj`, or `*.vbproj` files are present (default)
- unsupported_version_icon: `string` - text/icon that is displayed when the active .NET SDK version (e.g., one specified
by `global.json`) is not installed/supported - defaults to `\uf071` (X in a rectangle box)
2 changes: 1 addition & 1 deletion docs/docs/segment-golang.md
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Golang

## What

Display the currently active golang version when a folder contains `.go` files.
Display the currently active golang version when a folder contains golang files.

## Sample Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/segment-julia.md
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Julia

## What

Display the currently active julia version when a folder contains `.jl` files.
Display the currently active julia version when a folder contains julia files.

## Sample Configuration

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/segment-node.md
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Node

## What

Display the currently active node version when a folder contains `.js` or `.ts` files.
Display the currently active node version when a folder contains node files.

## Sample Configuration

Expand All @@ -29,4 +29,4 @@ Display the currently active node version when a folder contains `.js` or `.ts`
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: The segment is always displayed
- `files`: The segment is only displayed when `*.js`, `*.ts` or package.json files are present (default)
- `files`: The segment is only displayed when `*.js`, `*.ts`, or `package.json` files are present (default)
3 changes: 2 additions & 1 deletion docs/docs/segment-python.md
Expand Up @@ -33,6 +33,7 @@ or not - defaults to `true`
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: The segment is always displayed
- `files`: The segment is only displayed when `*.py` or `*.ipynb` files are present (default)
- `files`: The segment is only displayed when `*.py`, `*.ipynb`, `pyproject.toml`, `venv.bak`, `venv`, or `.venv`
files are present (default)
- `environment`: The segment is only displayed when a virtual env is present
- `context`: The segment is only displayed when either `environment` or `files` is active

0 comments on commit cdc9ff9

Please sign in to comment.