Skip to content

Make it clearer about each behavior toward null #1819

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

Closed

Conversation

hongquan
Copy link

  • Clearly mention what each does with the null items. I kept search around Nu docs for a thing like filter_map, until I tried each with null. I wish the docs were more obvious from the start.
  • Suggest a better method to iterate over keys / values in a record.
  • Add links to related commands.

Copy link
Contributor

Awesome that you are trying to improve the documentation of a nushell command!

You should not modify the files in commands/docs or commands/categories!
We autogenerate these command pages from the help information defined by the command implementation, after each release. Thus:

  • If you already updated the command help, you are already done and can close this PR!
  • Else, please look for the command in the source tree and make your changes directly there in the impl Command and Signature.
  • If you accidentally made a change in commands/ while working on general documentation, please revert changes to commands/

Thanks for helping out!

@fdncred
Copy link
Contributor

fdncred commented Feb 24, 2025

Thanks, but as per the robot, we can't change this stuff here. It has to be changed in the rust command itself. It's also probably not a good idea to have links since this help shows when you do each --help or help each.

@fdncred fdncred closed this Feb 24, 2025
@hongquan
Copy link
Author

Thank you. Will head to the Rust source instead.

sholderbach pushed a commit to nushell/nushell that referenced this pull request Feb 25, 2025
# Description

It is a rework of nushell/nushell.github.io#1819

So, I was wasting time looking for equivalent of `filter_map` in Nu,
unaware that `each` already has it. This PR is to make it clear in the
documentation, saving other user's time.

# User-Facing Changes

No

# Tests + Formatting

No

# After Submitting

No
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.

2 participants