Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix minor errors in book #1694

Merged
merged 5 commits into from
Dec 22, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion book/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Nushell uses a configuration system that loads and runs two Nushell script files at launch time:

- `env.nu` is used to define environment variables or write files before `config.nu` starts. For example [`$env.NU_LIB_DIRS`](/book/modules.md#dumping-files-into-directory) controls where Nu finds imports. Third party scripts, like prompts or [mise](https://mise.jdx.dev/getting-started.html#nushell), must already be saved to disk before `config.nu` can read them.
- `config.nu` is used to add definitions, aliases, and more to the global namespace. It can also use the environment variables and constants defined in `env.nu`. If you can't decide which file to add stuff, prefer `config.nu`.
- `config.nu` is used to add definitions, aliases, and more to the global namespace. It can also use the environment variables and constants defined in `env.nu`. If you can't decide which file to add stuff to, prefer `config.nu`.
HartBlanc marked this conversation as resolved.
Show resolved Hide resolved

Check where Nushell is reading these config files from by calling `$nu.env-path` and `$nu.config-path`.

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 @@ -453,7 +453,7 @@ drwxr-xr-x@ 4 pengs admin 128 14 Nov 13:42 en
(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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Putting a pin in here that we should change that once we get rid of the find-inserts-ANSI pathology. nushell/nushell#11899

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm glad to see this is being reviewed - it certainly tripped me up!

```

## Command Output in Nushell
Expand Down
4 changes: 3 additions & 1 deletion book/working_with_strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,4 +437,6 @@ You can color strings with the [`ansi`](/commands/docs/ansi.md) command. For exa
```

`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`_
HartBlanc marked this conversation as resolved.
Show resolved Hide resolved
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