[WIP] feat(params): Support inline parameter documentation #756
Conversation
This file contains 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
This allows users to add comments within destructuring patterns, ObjectPattern and ArrayPattern, that add documentation for specific parameters. Fixes #29
|
JSDoc usually comes before the code. Is that doable? If you put the comment on its own line or if the comment needs multiple lines it looks better before. |
|
Totally, that's doable and preferable, both for uniformity and to avoid looking like Flow comments. I'll swap trailing for leading. |
|
Punting on this in documentation.js, moving conversation to dx-spec tmcw/dx-spec#2 |
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.
Not ready for a merge: right now this introduces a bug where the documentation comment is both used as part of the param, and also gets output on its own.
This allows users to add comments within destructuring patterns, ObjectPattern and ArrayPattern,
that add documentation for specific parameters.
Fixes #29