Drop examples from closure language reference #1975
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. All listed commands link to their respective docs. 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to #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. All listed commands link to their respective docs.
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.