mirror of
https://github.com/nushell/nushell
synced 2024-12-26 13:03:07 +00:00
b304de8199
* Detect built-in commands passed as args to `which` This expands the built-in `which` command to detect nushell commands that may have the same name as a binary in the path. * Allow which to interpret multiple arguments Previously, it would discard any argument besides the first. This allows `which` to process multiple arguments. It also makes the output a stream of rows. * Use map to build the output * Add boolean column for builtins * Use macros for entry creation shortcuts * Process command args and use async_stream In order to use `ichwh`, I'll need to use async_stream. But in order to avoid lifetime errors with that, I have to process the command args before using them. I'll admit I don't fully understand what is going on with the `args.process(...)` function, but it works. * Use `ichwh` for path searching This commit transitions from `which` to `ichwh`. The path search is now done asynchronously. * Enable the `--all` flag on `which` * Make `which` respect external commands Escaped commands passed to wich (e.g., `which "^ls"`), are now searched before builtins. * Fix clippy warnings This commit resolves two warnings from clippy, in light of #1142. * Update Cargo.lock to get new `ichwh` version `ichwh@0.2.1` has support for local paths. * Add documentation for command |
||
|---|---|---|
| .. | ||
| add.md | ||
| append.md | ||
| average.md | ||
| cd.md | ||
| compact.md | ||
| config.md | ||
| count.md | ||
| date.md | ||
| default.md | ||
| echo.md | ||
| edit.md | ||
| enter.md | ||
| env.md | ||
| exit.md | ||
| fetch.md | ||
| first.md | ||
| format.md | ||
| from-csv.md | ||
| from-json.md | ||
| from-toml.md | ||
| from-tsv.md | ||
| from-xml.md | ||
| from-yaml.md | ||
| get.md | ||
| group-by.md | ||
| help.md | ||
| histogram.md | ||
| history.md | ||
| inc.md | ||
| last.md | ||
| lines.md | ||
| nth.md | ||
| open.md | ||
| pick.md | ||
| pivot.md | ||
| prepend.md | ||
| ps.md | ||
| README.md | ||
| reject.md | ||
| reverse.md | ||
| save.md | ||
| shells.md | ||
| size.md | ||
| sort-by.md | ||
| split-column.md | ||
| split-row.md | ||
| str.md | ||
| sum.md | ||
| sys.md | ||
| tags.md | ||
| to-csv.md | ||
| to-json.md | ||
| to-toml.md | ||
| to-tsv.md | ||
| to-url.md | ||
| to-yaml.md | ||
| trim.md | ||
| uniq.rs | ||
| version.md | ||
| where.md | ||
| which.md | ||
How do I get started?
Pick any command from the checklist and write a comment acknowledging you started work.
Instructions for documenting a Nu command of your choosing
Name the file after the command, like so:
command.md
Example: If you want to add documentation for the Nu command enter, create a file named enter.md, write documentation, save it at /docs/commands/[your_command_picked].md as and create your pull request.
What kind of documentation should I write?
Anything you want that you believe it best documents the command and the way you would like to see it. Here are some of our ideas of documentation we would love to see (feel free to add yours):
- Examples of using the command (max creativity welcomed!)
- Description of the command.
- Command usage.
Anything else?
Of course! (These are drafts) so feel free to leave feedback and suggestions in the same file.
Happy Documenting.