extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-05-10 04:54:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update default-files README (#14461)

Browse Source 
# Description

Someone noticed today that I had left a TODO in the Readme. It has since
been completed and needed to be removed. Also made some other minor
fixes and wordsmithing while I was in it.

# User-Facing Changes

None

# Tests + Formatting

Clippy and fmt passed, and that should be all that matters on the
Readme.

# After Submitting

N/A
This commit is contained in:
Douglas 2024-11-28 02:04:42 -05:00 committed by GitHub
parent a13a024ac8
commit bccff3b237
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/nu-utils/src/default_files/README.md
View File

@ -7,10 +7,8 @@
* Will be loaded during any startup where the user's `env.nu` is also loaded. For example: * Will be loaded during any startup where the user's `env.nu` is also loaded. For example:
* During normal startup with `nu` * During normal startup with `nu`
* During a startup where the user specifies an alternative `env.nu` via `nu --env-config <path>` * During a startup where the user specifies an alternative `env.nu` via `nu --env-config <path>`
* Likewise, is never loaded during a startup where the user's `env.nu` would not be loaded. For example: * During a `nu -c <commandstring>` or `nu <script>` startup so that `ENV_CONVERSIONS` is properly handled for Windows.
* `nu -n/--no-config` * Is *not* loaded when running with an explicit `no --no-config-file (-n)`.
* `nu -c "ls"`
* `nu <script.nu>`
* Is not commented - Comments are in `sample_env.nu`. * Is not commented - Comments are in `sample_env.nu`.
* Should be optimized for fastest load times. * Should be optimized for fastest load times.
* Can be introspected via `config env --default | nu-highlight` * Can be introspected via `config env --default | nu-highlight`
@ -42,8 +40,7 @@ Counterpart to `default_env.nu`.
## `sample_env.nu` ## `sample_env.nu`
* A commented file documenting the most common environment variables that a user might configure in `env.nu` * A commented file documenting the most common environment variables that a user might configure in `env.nu`
* For convenient in-shell access * For convenient in-shell access - Can be pretty-printed via `config env --sample | nu-highlight`
* Can be pretty-printed via `config env --sample | nu-highlight`
* Since this file is for documentation only, include actual Nushell code without comments so that it can be pretty-printed * Since this file is for documentation only, include actual Nushell code without comments so that it can be pretty-printed
* No optimization necessary - Not intended for use other than documentation. * No optimization necessary - Not intended for use other than documentation.
* Consider replacing `config env --sample` with `help env.nu` at some point. * Consider replacing `config env --sample` with `help env.nu` at some point.
@ -53,11 +50,8 @@ Counterpart to `default_env.nu`.
Counterpart to `sample_env.nu`. Counterpart to `sample_env.nu`.
TODO: **Not in final form**
* A commented file documenting the most common environment variables that a user might configure in `config.nu` * A commented file documenting the most common environment variables that a user might configure in `config.nu`
* For convenient in-shell access * For convenient in-shell access - Can be pretty-printed via `config nu --sample | nu-highlight`
* Can be pretty-printed via `config nu --sample | nu-highlight`
* Since this file is for documentation only, include actual Nushell code without comments so that it can be pretty-printed * Since this file is for documentation only, include actual Nushell code without comments so that it can be pretty-printed
* No optimization necessary - Not intended for use other than documentation. * No optimization necessary - Not intended for use other than documentation.
* Consider replacing `config nu --sample` with `help config.nu` at some point. * Consider replacing `config nu --sample` with `help config.nu` at some point.