nushell / nushell/nushell

Documentation for what a condition is inside the built-in help

Open
#11,117 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category:documentation category:enhancement status:needs-triage
Dominant language
Rust
Stars
40.5k
Forks
2.3k
Avg merge
1d 19h
Merged PRs (30d)
85

Description

Related problem

looking at the docs for where (via help where), it's not clear how to figure out what the condition syntax is.

Describe the solution you'd like

A pointer to "condition sytanx" inside the shell (notably stuff in help operators), so that I can see how to write an expression I'm thinking of in the shell docs as-is.

Describe alternatives you've considered

There's obviously the documentation on the website which is helpful enough. But given that we have this "condition" type described in where, it feels logical to have something to point to from ther.

Additional context and details

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the built-in help shown by help where and compare it with help operators, especially the description of condition syntax. Done means the where help points users to the relevant condition or operator documentation so they can write expressions in the shell.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.