Skip to content

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

Open
@ryanwelcher

Description

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions