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

Data Module: Improve Selectors/Actions docs #7287

Closed
youknowriad opened this issue Jun 12, 2018 · 3 comments
Closed

Data Module: Improve Selectors/Actions docs #7287

youknowriad opened this issue Jun 12, 2018 · 3 comments
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Package] Data /packages/data [Type] Developer Documentation Documentation for developers

Comments

@youknowriad
Copy link
Contributor

Related #7264

Now, that we generate markdown docs for Selectors and Actions, we need to make sure the wording used there is accurate and not redundant.

For instance: Actions shouldn't state that they return action objects.

Instead of Returns an action object used in signalling that block types have been added., write Signal that a block type, or types, have been added.

More details here #7264 (review)

@youknowriad youknowriad added [Type] Developer Documentation Documentation for developers Good First Issue An issue that's suitable for someone looking to contribute for the first time labels Jun 12, 2018
@gziolo gziolo added this to the Merge Proposal: Documentation milestone Jun 12, 2018
@gziolo gziolo added the [Package] Data /packages/data label Jun 12, 2018
@aduth
Copy link
Member

aduth commented Jun 12, 2018

Hmm, but they're worded as such because the functions alone do not signal anything, they do return action objects, even if in the typical sense they are only used in dispatching to a Redux store.

@tofumatt
Copy link
Member

Yeah, but wording them all to say they just return an object doesn't imply how/why they're actually used. As mentioned in this comment, I think the middle ground is to say the entire set of functions returns the object, but then describe each function on the action it creates when passed to the store's dispatch() function.

Describing the actions all as just "functions that return objects" isn't very informative 😄

@mcsf mcsf changed the title Data Modue: Improve Selectors/Actions docs Data Module: Improve Selectors/Actions docs Jul 19, 2018
@youknowriad
Copy link
Contributor Author

Seems like there's no consensus here, I'm closing this issue right now but we can still reconsider.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Package] Data /packages/data [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

4 participants