[www] API docs: return values not rendered #8203
Labels
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
Comments
|
Hmm this seems like an oversight. Could you look into a PR for this? |
|
Sure. |
|
Thanks! |
kakadiadarpan
added
the
type: documentation
DSchau
pushed a commit
that referenced
this issue
Feb 13, 2019
This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | prop-types | dependencies | patch | `^15.7.1` -> `^15.7.2` | [homepage](https://facebook.github.io/react/), [source](https://github.com/facebook/prop-types) | --- ### Release Notes <details> <summary>facebook/prop-types</summary> ### [`v15.7.2`](https://github.com/facebook/prop-types/blob/master/CHANGELOG.md#​1572) [Compare Source](https://github.com/facebook/prop-types/compare/v15.7.1...v15.7.2) - [Fix] ensure nullish values in `oneOf` do not crash ([#​256](https://github.com/facebook/prop-types/issues/256)) - [Fix] move `loose-envify` back to production deps, for browerify usage ([#​203](https://github.com/facebook/prop-types/issues/203)) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby).
gurpreet-hanjra
pushed a commit
to gurpreet-hanjra/gatsby
that referenced
this issue
Feb 14, 2019
This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | prop-types | dependencies | patch | `^15.7.1` -> `^15.7.2` | [homepage](https://facebook.github.io/react/), [source](https://github.com/facebook/prop-types) | --- ### Release Notes <details> <summary>facebook/prop-types</summary> ### [`v15.7.2`](https://github.com/facebook/prop-types/blob/master/CHANGELOG.md#​1572) [Compare Source](https://github.com/facebook/prop-types/compare/v15.7.1...v15.7.2) - [Fix] ensure nullish values in `oneOf` do not crash ([#&gatsbyjs#8203;256](https://github.com/facebook/prop-types/issues/256)) - [Fix] move `loose-envify` back to production deps, for browerify usage ([#&gatsbyjs#8203;203](https://github.com/facebook/prop-types/issues/203)) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby).
DSchau
pushed a commit
that referenced
this issue
Feb 15, 2019
This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | react | dependencies | patch | `^16.8.1` -> `^16.8.2` | [homepage](https://reactjs.org/), [source](https://github.com/facebook/react) | | react-dom | dependencies | patch | `^16.8.1` -> `^16.8.2` | [homepage](https://reactjs.org/), [source](https://github.com/facebook/react) | --- ### Release Notes <details> <summary>facebook/react</summary> ### [`v16.8.2`](https://github.com/facebook/react/blob/master/CHANGELOG.md#​1682-February-14-2019) [Compare Source](https://github.com/facebook/react/compare/v16.8.1...v16.8.2) ##### React DOM - Fix `ReactDOM.render` being ignored inside `useEffect`. ([@​gaearon](https://github.com/gaearon) in [#​14799](https://github.com/facebook/react/pull/14799)) - Fix a crash when unmounting empty portals. ([@​gaearon](https://github.com/gaearon) in [#​14820](https://github.com/facebook/react/pull/14820)) - Fix `useImperativeHandle` to work correctly when no deps are specified. ([@​gaearon](https://github.com/gaearon) in [#​14801](https://github.com/facebook/react/pull/14801)) - Fix `crossOrigin` attribute to work in SVG `image` elements. ([@​aweary](https://github.com/aweary) in [#​14832](https://github.com/facebook/react/pull/14832)) - Fix a false positive warning when using Suspense with Hooks. ([@​gaearon](https://github.com/gaearon) in [#​14821](https://github.com/facebook/react/pull/14821)) ##### React Test Utils and React Test Renderer - Include component stack into the `act()` warning. ([@​threepointone](https://github.com/threepointone) in [#​14855](https://github.com/facebook/react/pull/14855)) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :no_bell: **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby).
pieh
pushed a commit
that referenced
this issue
Mar 28, 2019
This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | react | dependencies | patch | [`^16.8.5` -> `^16.8.6`](https://diff.intrinsic.com/react/16.8.5/16.8.6) | [homepage](https://reactjs.org/), [source](https://github.com/facebook/react/tree/HEAD/packages/react) | | react-dom | dependencies | patch | [`^16.8.5` -> `^16.8.6`](https://diff.intrinsic.com/react-dom/16.8.5/16.8.6) | [homepage](https://reactjs.org/), [source](https://github.com/facebook/react/tree/HEAD/packages/react-dom) | --- ### Release Notes <details> <summary>facebook/react</summary> ### [`v16.8.6`](https://github.com/facebook/react/blob/master/CHANGELOG.md#​1686-March-27-2019) [Compare Source](https://github.com/facebook/react/compare/v16.8.5...v16.8.6) ##### React DOM - Fix an incorrect bailout in `useReducer()`. ([@​acdlite](https://github.com/acdlite) in [#​15124](https://github.com/facebook/react/pull/15124)) - Fix iframe warnings in Safari DevTools. ([@​renanvalentin](https://github.com/renanvalentin) in [#​15099](https://github.com/facebook/react/pull/15099)) - Warn if `contextType` is set to `Context.Consumer` instead of `Context`. ([@​aweary](https://github.com/aweary) in [#​14831](https://github.com/facebook/react/pull/14831)) - Warn if `contextType` is set to invalid values. ([@​gaearon](https://github.com/gaearon) in [#​15142](https://github.com/facebook/react/pull/15142)) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :no_bell: **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby).
1 task
1 task
1 task
1 task
1 task
1 task
1 task
1 task
pragmaticpat
pushed a commit
to pragmaticpat/gatsby
that referenced
this issue
Apr 28, 2022
This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | prop-types | dependencies | patch | `^15.7.1` -> `^15.7.2` | [homepage](https://facebook.github.io/react/), [source](https://github.com/facebook/prop-types) | --- ### Release Notes <details> <summary>facebook/prop-types</summary> ### [`v15.7.2`](https://github.com/facebook/prop-types/blob/master/CHANGELOG.md#​1572) [Compare Source](https://github.com/facebook/prop-types/compare/v15.7.1...v15.7.2) - [Fix] ensure nullish values in `oneOf` do not crash ([#&gatsbyjs#8203;256](https://github.com/facebook/prop-types/issues/256)) - [Fix] move `loose-envify` back to production deps, for browerify usage ([#&gatsbyjs#8203;203](https://github.com/facebook/prop-types/issues/203)) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby).
pragmaticpat
pushed a commit
to pragmaticpat/gatsby
that referenced
this issue
Apr 28, 2022
This PR contains the following updates: | Package | Type | Update | Change | References | |---|---|---|---|---| | react | dependencies | patch | `^16.8.1` -> `^16.8.2` | [homepage](https://reactjs.org/), [source](https://github.com/facebook/react) | | react-dom | dependencies | patch | `^16.8.1` -> `^16.8.2` | [homepage](https://reactjs.org/), [source](https://github.com/facebook/react) | --- ### Release Notes <details> <summary>facebook/react</summary> ### [`v16.8.2`](https://github.com/facebook/react/blob/master/CHANGELOG.md#​1682-February-14-2019) [Compare Source](https://github.com/facebook/react/compare/v16.8.1...v16.8.2) ##### React DOM - Fix `ReactDOM.render` being ignored inside `useEffect`. ([@&gatsbyjs#8203;gaearon](https://github.com/gaearon) in [#&gatsbyjs#8203;14799](https://github.com/facebook/react/pull/14799)) - Fix a crash when unmounting empty portals. ([@&gatsbyjs#8203;gaearon](https://github.com/gaearon) in [#&gatsbyjs#8203;14820](https://github.com/facebook/react/pull/14820)) - Fix `useImperativeHandle` to work correctly when no deps are specified. ([@&gatsbyjs#8203;gaearon](https://github.com/gaearon) in [#&gatsbyjs#8203;14801](https://github.com/facebook/react/pull/14801)) - Fix `crossOrigin` attribute to work in SVG `image` elements. ([@&gatsbyjs#8203;aweary](https://github.com/aweary) in [#&gatsbyjs#8203;14832](https://github.com/facebook/react/pull/14832)) - Fix a false positive warning when using Suspense with Hooks. ([@&gatsbyjs#8203;gaearon](https://github.com/gaearon) in [#&gatsbyjs#8203;14821](https://github.com/facebook/react/pull/14821)) ##### React Test Utils and React Test Renderer - Include component stack into the `act()` warning. ([@&gatsbyjs#8203;threepointone](https://github.com/threepointone) in [#&gatsbyjs#8203;14855](https://github.com/facebook/react/pull/14855)) </details> --- ### Renovate configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or if you modify the PR title to begin with "`rebase!`". :no_bell: **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#gatsbyjs/gatsby).
1 task
1 task
Closed
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The API documentation does not show the function's return values, even though they have jsdoc
@returns. See e.g. here.This is because the returns don't get rendered in
function-list.jsThe text was updated successfully, but these errors were encountered: