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

Tooling: Improve docs build to consider memoized selectors #9756

Merged
merged 1 commit into from Sep 10, 2018

Conversation

Projects
None yet
2 participants
@aduth
Member

aduth commented Sep 10, 2018

Previously: #7264

This pull request seeks to improve our docs parser to consider memoized selectors. These were previously omitted because they aren't technically FunctionDeclaration, and our logic thus omitted them. It was assumed the omission is based on some files including other non-selector/actions exports which are not intended to be documented as if they were. With these changes is an attempt to preserve this intent while allowing for memoized selectors to be included in the parsed documentation. This is done by considering a selector as one which has a DocBlock containing at least one @param tag, which we assume as always being the case with state as the first argument.

Testing instructions:

Ensure no changes, errors, or included non-selector/actions with npm run docs:build.

@youknowriad

This comment has been minimized.

Show comment
Hide comment
@youknowriad

youknowriad Sep 10, 2018

Contributor

What if we export just a const (to be used in reducers or whatever), will it be caught by this update? should we target memoized selectors explicitly (createSelector calls)

Contributor

youknowriad commented Sep 10, 2018

What if we export just a const (to be used in reducers or whatever), will it be caught by this update? should we target memoized selectors explicitly (createSelector calls)

@youknowriad

This comment has been minimized.

Show comment
Hide comment
@youknowriad

youknowriad Sep 10, 2018

Contributor

Ok I just saw your exclusion rule :)

Contributor

youknowriad commented Sep 10, 2018

Ok I just saw your exclusion rule :)

@youknowriad

LGTM 👍

@aduth aduth merged commit 2fa3d3d into master Sep 10, 2018

2 checks passed

codecov/project 49.02% remains the same compared to 960bb6e
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@aduth aduth deleted the fix/docs-memoized-selectors branch Sep 10, 2018

@aduth aduth added this to the 3.9 milestone Sep 10, 2018

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