nushell/crates/nu-utils/src
Douglas c0ad659985
Doc file fixes (#14608)
# Description

With great thanks to @fdncred and especially @PerchunPak (see #14601)
for finding and fixing a number of issues that I pulled in here due to
the filename changes and upcoming freeze.

This PR primarily fixes a poor wording choice in the new filenames and
`config` command options. The fact that these were called
`sample_config.nu` (etc.) and accessed via `config --sample` created a
great deal of confusion. These were never intended to be used as-is as
config files, but rather as in-shell documentation.

As such, I've renamed them:

* `sample_config.nu` becomes `doc_config.nu`
* `sample_env.nu` becomes `doc_env.nu`
* `config nu --sample` becomes `config nu --doc`
* `config env --sample` because `config env --doc`

Also the following:

* Updates `doc_config.nu` with a few additional comment-fixes on top of
@PerchunPak's changes.
* Adds version numbers to all files - Will need to update the version
script to add some files after this PR.
* Additional doc on plugin and plugin_gc configuration which I had
failed to previously completely update from the older wording
* Updated the comments in the `scaffold_*.nu` files to point people to
`help config`/`help nu` so that, if things change in the future, it will
become more difficult for the comments to be outdated.
* 

# User-Facing Changes

Mostly doc.

`config nu` and `config env` changes update new behavior previously
added in 0.100.1

# Tests + Formatting

- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`

# After Submitting

* Update configuration chapter of doc
* Update the blog entry on migrating config
* Update `bump-version.nu`
2024-12-17 14:18:23 -06:00
..
default_files Doc file fixes (#14608) 2024-12-17 14:18:23 -06:00
casing.rs Switch to unicase's to_folded_case (#14255) 2024-11-05 09:39:08 +01:00
deansi.rs allow tab to be retained with find (#13848) 2024-09-14 08:51:00 -05:00
emoji.rs add special emoji handling for debug --raw (#11368) 2023-12-19 13:09:31 -06:00
filesystem.rs Start to Add WASM Support Again (#14418) 2024-11-30 07:57:11 -06:00
lib.rs Doc file fixes (#14608) 2024-12-17 14:18:23 -06:00
locale.rs Reduce again the number of match calls (#7815) 2023-01-24 12:23:42 +01:00
main.rs added nu-utils crate, fixed issue where externals turn off vt processing (#4857) 2022-03-16 17:21:06 -05:00
quoting.rs Improve CellPath display output (#14197) 2024-11-02 10:28:10 -05:00
shared_cow.rs Copy-on-write for record values (#12305) 2024-04-14 01:42:03 +00:00
utils.rs Doc file fixes (#14608) 2024-12-17 14:18:23 -06:00