Skip to content

Link commands in lang-guide closure command list#1973

Merged
fdncred merged 1 commit into
nushell:mainfrom
Kissaki:patch-4
Jul 12, 2025
Merged

Link commands in lang-guide closure command list#1973
fdncred merged 1 commit into
nushell:mainfrom
Kissaki:patch-4

Conversation

@Kissaki
Copy link
Copy Markdown
Contributor

@Kissaki Kissaki commented Jul 12, 2025

Improvement related to #1929

@fdncred fdncred merged commit 31e9861 into nushell:main Jul 12, 2025
2 checks passed
@fdncred
Copy link
Copy Markdown
Contributor

fdncred commented Jul 12, 2025

Thanks

Kissaki added a commit to Kissaki/nushell.github.io that referenced this pull request Jul 12, 2025
Relates to nushell#1929

The language reference should be focused on the language concepts, not describe how various commands make use of it, and especially not in the form of examples.

All these commands have closure examples in the docs comments. After PR nushell#1973 has been merged, all commands in the list will link to each command's documentation.

Dropping the examples increases focus of the *reference* doc, and reduces risks of doc duplication and of command changes leading to outdated lang ref docs.
Kissaki added a commit to Kissaki/nushell.github.io that referenced this pull request Jul 12, 2025
Relates to nushell#1929

The language reference should be focused on the language concepts, not describe how various commands make use of it, and especially not in the form of examples.

All these commands have closure examples in the docs comments. After PR nushell#1973 has been merged, all commands in the list will link to each command's documentation.

Dropping the examples increases focus of the *reference* doc, and reduces risks of doc duplication and of command changes leading to outdated lang ref docs.
@Kissaki Kissaki deleted the patch-4 branch July 12, 2025 20:00
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