Skip to content
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

None of the dynamically generated selectors are documented for core-data package #64215

Open
ryanwelcher opened this issue Aug 2, 2024 · 1 comment
Assignees
Labels
Developer Experience Ideas about improving block and theme developer experience [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.

Comments

@ryanwelcher
Copy link
Contributor

ryanwelcher commented Aug 2, 2024

What problem does this address?

The documentation for the core-data package has no entries for any of the dynamically generated selectors that are built based on registered entities.

These selectors are much easier to use and understand then the underlying getEntity/getEntities selectors that power them.

They are missing because the docgen tool has no definition to retrieve from the source and so they are not added to the generated docs.

What is your proposed solution?

There are two possible solutions here:

1: Update the associated .md files manually to add the missing selectors

This approach is probably the easiest to implement as any contributor can update the docs as needed but is subject to human error and requires manual updates should APIs change.

2: Update the docgen tool to process automatically

This is much more work to implement and requires specific knowledge to implement by any one wishing to take this one.

I would propose that we start with manual updates and see what level of effort it would be to update docgen tool at a later date.

@ryanwelcher ryanwelcher added [Type] Enhancement A suggestion for improvement. [Type] Developer Documentation Documentation for developers Developer Experience Ideas about improving block and theme developer experience labels Aug 2, 2024
@ryanwelcher
Copy link
Contributor Author

ryanwelcher commented Aug 2, 2024

The for manual approach, they can be added above the START_TOKEN line in each section. This will allow them to be added before the generated ones are added.

@ryanwelcher ryanwelcher self-assigned this Aug 2, 2024
@bph bph changed the title None of the dynamically generated selectors are documented for for core-data package None of the dynamically generated selectors are documented for core-data package Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience Ideas about improving block and theme developer experience [Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

1 participant