Skip to content

Conversation

@Kissaki
Copy link
Contributor

@Kissaki Kissaki commented Nov 17, 2024

Replace "Notes on Errors when Piping Commands" section content with PowerShell references with neutral and more general and extensive "Command Input and Output Types" content.

  • Approach the input output types docs from the Basics context rather than PowerShell behavior and situational errors
  • Introduce in a more natural and introductory order:
    1. Discover input output types of commands via help
    2. Usable case
    3. Problematic case with unintended behavior due to command default behavior
    4. Unsupported case with error
  • Add example pipeline expressions for the supported good case
  • Describe alternatives like before
  • Keep description of why and in what way commands differ in input output support

With the new approach, mentioning PowerShell felt misplaced. Nushell stands well on its own. The relevant error is still there (remains searchable and discoverable). PowerShell specifics would feel more appropriate in a "Coming from PowerShell" documentation.

Replace "Notes on Errors when Piping Commands" section content with PowerShell references with neutral and more general and extensive "Command Input and Output Types" content.

* Approach the input output types docs from the Basics context rather than PowerShell behavior and situational errors
* Introduce in a more natural and introductory order:
  1. Discover input output types of commands via `help`
  2. Usable case
  3. Problematic case with unintended behavior due to command default behavior
  4. Unsupported case with error
* Add example pipeline expressions for the supported good case
* Describe alternatives like before
* Keep description of why and in what way commands differ in input output support

With the new approach, mentioning PowerShell felt misplaced. Nushell stands well on its own. The relevant error is still there (remains searchable and discoverable). PowerShell specifics would feel more appropriate in a "Coming from PowerShell" documentation.
Link first occurrences of commands in section to command docs.
@NotTheDr01ds
Copy link
Contributor

Thanks! Also looks good to me. I might do some very-minor wordsmithing later, and I'll cc you on it if/when I do, but this is a good improvement over the original, IMHO.

@fdncred fdncred merged commit f427ba4 into nushell:main Nov 17, 2024
2 checks passed
@fdncred
Copy link
Contributor

fdncred commented Nov 17, 2024

Thanks

@Kissaki Kissaki deleted the docs/pipelines-cmdinouterr branch April 12, 2025 16:40
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.

3 participants