nushell / nushell/nushell.github.io
Improve documentation on "magic" variables
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
I've noticed here and there that it is possible to directly refer to a parameter in a command without declaring it in a block. E.g.
echo $scores | where $it > 7
[1, 2, 3] | $in.2
It appeals to me because I find that the declaration part with the pipes is a little annoying to type. But I can't find any documentation on when and where it might be used.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Nushell documentation covering command parameters and the $it and $in variables shown in the examples. Document when these implicit variables can be used and what their scope is, with examples based on the issue; done means a reader can find and understand the supported usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100