-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Data: Documentation: Document undocumented declarations #15176
Conversation
* A context consumer component which provides to the rendered child function a | ||
* reference to the current registry context. | ||
* | ||
* @link https://reactjs.org/docs/context.html#contextconsumer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prefer the @see
tag (see)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export { createRegistrySelector, createRegistryControl } from './factory'; | ||
|
||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wish we had a better way to auto-document this. Unfortunately, we don't yet.
- One approach could've been using
@property
tags. Current issue docgen: pull type definitions from @typedef #15186 - Another approach could've been using whatever mechanism we end up implementing to group things together. Current issue: docgen: add support for classes and groups of things #15178
It looks fine to me, but I defer to other people with more data-foo in case they have any input about the text itself. |
c10bcab
to
2e82ebf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is better than what we have currently (certainly better than "undocumented") so I'm in favor of merging this for now and it can be iterated on if needed?
This pull request seeks to add missing documentation for data module exports:
plugins
use
RegistryConsumer
RegistryProvider
Implementation notes:
The
plugins
documentation here could be improved to better reference available options. However, it's not clear how to reference this without adding overhead to future updates to these plugins, which would likely be overlooked. Suggestions welcome.Testing Instructions:
Verify by rendered output of "Files changed" tab that produced documentation is sensible.
There are only documentation changes. Thus, there is no expected impact on application runtime.