Skip to content

Commit

Permalink
Fix minor errors in book (#1694)
Browse files Browse the repository at this point in the history
* fix errors in en book

* revert configuration changes to prevent merge conflict

* fix VuePress tip callout

* one more typo
  • Loading branch information
HartBlanc authored Dec 22, 2024
1 parent 97e7cab commit 5ddd366
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 7 deletions.
2 changes: 1 addition & 1 deletion book/externs.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Notice that the syntax here is similar to that of the `def` keyword when definin

This implementation:

- Will provide `-p` and `-i` (with descriptions) as possibly completions for `ssh -`.
- Will provide `-p` and `-i` (with descriptions) as possible completions for `ssh -`.
- Will perform parse-time type checking. Attempting to use a non-`int` for the port number will result in an error (and error-condition syntax highlighting).
- Will offer parse-time syntax highlighting based on the shapes of the arguments.
- Will offer any private key files in `~/.ssh` as completion values for the `-i` (identity) option
Expand Down
6 changes: 3 additions & 3 deletions book/nu_as_a_shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ An interesting feature of Nushell is the [Directory Stack](directory_stack.md) w
Nushell also has its own line editor [Reedline](line_editor.md).
With Nushell's config, it is possible to configure some of the Reedline's features, such as the prompt, keybindings, history, or menus.

It is also possible to define [custom signatures for external commands](externs.md) which lets you define [custom completions](custom_completions.md) for them (the custom completions work also for Nushell custom commands).
It is also possible to define [custom signatures for external commands](externs.md) which lets you define [custom completions](custom_completions.md) for them (the custom completions also work for Nushell custom commands).

[Coloring and Theming in Nu](coloring_and_theming.md) goes into more detail about how to configure Nushell's appearance.

If you want to schedule some commands to run in the background, [Background task in Nu](background_task.md) provide a simple guideline for you to follow.
If you want to schedule some commands to run in the background, [Background task in Nu](background_task.md) provides simple guidelines for you to follow.

And finally, [hooks](hooks.md) allow you to insert fragments of Nushell code to run at certain events.
Finally, [hooks](hooks.md) allow you to insert fragments of Nushell code to run at certain events.
2 changes: 1 addition & 1 deletion book/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ ls /usr/share/nvim/runtime/ | get name | to text | ^grep tutor | tr -d '\n' | ^l
(Actually, for this simple usage you can just use [`find`](/commands/docs/find.md))

```nu
ls /usr/share/nvim/runtime/ | get name | find tutor | ^ls -al $in
ls /usr/share/nvim/runtime/ | get name | find tutor | ansi strip | ^ls -al ...$in
```

## Command Output in Nushell
Expand Down
6 changes: 5 additions & 1 deletion book/working_with_strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,4 +437,8 @@ $'(ansi purple_bold)This text is a bold purple!(ansi reset)'
```

`ansi purple_bold` makes the text a bold purple
`ansi reset` resets the coloring to the default. (Tip: You should always end colored strings with `ansi reset`)
`ansi reset` resets the coloring to the default.

::: tip
You should always end colored strings with `ansi reset`
:::
2 changes: 1 addition & 1 deletion lang-guide/chapters/types/basic_types/range.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
╰───┴───╯
```

1. Conversion - A ranges may be converted to a `list` using:
1. Conversion - A range may be converted to a `list` using:

```nu
1..5 | each {||}
Expand Down

0 comments on commit 5ddd366

Please sign in to comment.