Data: Documentation: Document undocumented declarations#15176
Merged
Conversation
oandregal
reviewed
Apr 25, 2019
| * 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 |
Member
Author
oandregal
reviewed
Apr 26, 2019
| export { plugins }; | ||
| export { createRegistrySelector, createRegistryControl } from './factory'; | ||
|
|
||
| /** |
Member
There was a problem hiding this comment.
I wish we had a better way to auto-document this. Unfortunately, we don't yet.
- One approach could've been using
@propertytags. 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
Member
|
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. |
6 tasks
c10bcab to
2e82ebf
Compare
Member
Author
nerrad
approved these changes
May 28, 2019
Contributor
nerrad
left a comment
There was a problem hiding this comment.
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 file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This pull request seeks to add missing documentation for data module exports:
pluginsuseRegistryConsumerRegistryProviderImplementation notes:
The
pluginsdocumentation 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.