[www] API docs: render return values #8208
Merged
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 API docs currently do not render a function's return value defined with jsdoc
@returns
. This PR fixes this for the simple case where@returns {type} description
@returns {(type|type|type)] description
.What is not supported is defining multiple return values as separate
@returns
statements. This currently does not work because of a bug ingatsby-transformer-documentationjs
: the description of each@returns
statement (DocumentationJSComponentDescription
nodes) has the sameid
and thus all return statements get the description text of the last@returns
statement.What's also not supported is more complex syntax like
@returns {Array<number>}
, but I think that's not used in the API docs.Fixes #8203
Edit: Also fix two small errors in the docs.