fix(docs): Fix docs generation for method return values #3064
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
The `@returns` tags were ignored and instead `@return` was used, but the tag object wasn't properly converted to a string resulting in the output `[object Object]`.
splitinfinities
added
the
Resolution: Refine
tricki
changed the title
rwaskiewicz
suggested changes
Sep 29, 2021
There was a problem hiding this comment.
Thanks @tricki! I took your PR for a spin, and things are looking good. I had one small ask regarding backwards compatibility. Let me know what you think!
rwaskiewicz
added
the
Awaiting Reply
Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
rwaskiewicz
approved these changes
Oct 1, 2021
There was a problem hiding this comment.
Note to future me/team/community members. This is technically a breaking change to the output, but is simultaneously a nice bug fix for doc generation. Since the output was previously unusable (it output [Object object]), I am erring on the side of this being added to the next minor release of Stencil
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.
The
@returnstags were ignored and instead@returnwas used, but the tag object wasn't properly converted to a string resulting in the output[object Object].Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm test) were run locally and passednpm run test.karma.prod) were run locally and passednpm run prettier) was run locally and passedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
@returnswas ignored and@returnwasn't serialized, rendering it unusable.GitHub Issue Number: N/A
What is the new behavior?
@returnsis properly output.Does this introduce a breaking change?
Technically, you could say it's a breaking change but from a buggy state so it's very unlikely anyone has used
@returnbefore.Testing
Other information
Before:
After:
