Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update command input/output docs #254

Merged
merged 1 commit into from
Mar 5, 2022
Merged

Update command input/output docs #254

merged 1 commit into from
Mar 5, 2022

Conversation

rgwood
Copy link
Collaborator

@rgwood rgwood commented Mar 5, 2022

Context

Earlier today I was trying to replace part of a pipeline with a helper function. It took me a little while to figure it out, and somehow I bounced off the documentation without fully understanding it.

Changes

  • Make it extra clear that the docs are referring to pipeline input/output. This should be obvious on a close read but I think I misunderstood it on a quick skim.
  • Rewrite the pipeline input example for engine-q; it no longer works on main because each expects a parameter.

Considerations

I initially tried to keep the exact functionality of the my-echo example but Nushell has changed enough to make that difficult; if you just add an |it| parameter it parses but the function incorrectly returns a list of lists:

image

So instead I just copied the first example from help each.

- Make it a bit more clear that input/output refers to pipeline input/output
- Fix pipeline input example for engine-q
@fdncred fdncred merged commit 3325dc7 into nushell:main Mar 5, 2022
@fdncred
Copy link
Collaborator

fdncred commented Mar 5, 2022

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants