Add attributes documentation for custom commands. #2118
Merged
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
Contributor
|
Thanks. I think the words are fine. It's better than we had. Appreciate the help! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR updates
/book/custom_commands.mdwith a short section on utilizing attributes.I couldn't think of a good way to incorporate the completion examples based on the section I wrote, so this could be improved in future updates. I erred on the side of minimizing examples and pointing users towards the command reference which will be more likely to remain current with the available attributes, which I assume will be extended over time.
Is there a defined "voice" or style guide for writing sections for the Nu Book? I tried to stick closely to the wording of other sections, but would appreciate more clarity on how to maintain cohesion between different authors when contributing.