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.

Sign up for GitHub

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

Jump to bottom

📕 Add documentation for query exclude keys #632

Closed
TomWFox opened this issue Jul 11, 2019 · 7 comments · Fixed by #649
Closed

📕 Add documentation for query exclude keys #632

TomWFox opened this issue Jul 11, 2019 · 7 comments · Fixed by #649
Labels
type:docs

Comments

@TomWFox
Copy link
Contributor

TomWFox commented Jul 11, 2019 •
edited
Loading

See parse-community/parse-server#5737 for the server implementation.
See parse-community/Parse-SDK-JS#857 for the JS SDK implementation.
See parse-community/parse-php-sdk#445 for the PHP SDK implementation.
@TomWFox TomWFox changed the title 📙 Add query exclude keys to guides 📕 Add query exclude keys to guides Jul 11, 2019
@TomWFox TomWFox changed the title 📕 Add query exclude keys to guides 📕 Add documentation for query exclude keys Jul 11, 2019
@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 14, 2019

@RaschidJFR would you like to take a stab at the documentation?

@RaschidJFR
Copy link
Contributor

Sure thing. If you don't mind, I'll have a look at this next week as I currently got a high work load. The documentation to update should be the REST guide, right?

@RaschidJFR RaschidJFR mentioned this issue Jul 15, 2019
Closed
@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 15, 2019

If you can, both the REST and JS guides will need updating. No huge rush, some features go undocumented for months so a week or so won't do any harm.

@RaschidJFR RaschidJFR mentioned this issue Jul 25, 2019
Merged
@RaschidJFR
Copy link
Contributor

So I've sent my PR for the REST guide.
For the JS guide, is there any particular part you know is missing documentation?

@dplewis
Copy link
Member

dplewis commented Jul 25, 2019

@RaschidJFR can you also do the PHP docs? If not I can build on your PR.

@RaschidJFR
Copy link
Contributor

Sorry, I’m not familiar with the PHP SDK :/
Anything else on the JS?

Sent with GitHawk

@dplewis
Copy link
Member

dplewis commented Jul 25, 2019

An example of query.exclude(...) should be enough

RaschidJFR added a commit to RaschidJFR/docs that referenced this issue Jul 26, 2019
@RaschidJFR
Add .exclude() example to JS Guide
094451f 
Added example of Query.exclude() in `js/queries.md`
Closes parse-community#632
TomWFox pushed a commit that referenced this issue Jul 28, 2019
@RaschidJFR @TomWFox
Add keys and excludeKeys options to REST docs (#649)
0c86bc0 
* Add `keys` and `excludeKeys` options to REST docs

* Add `.exclude()` example to JS Guide

Added example of Query.exclude() in `js/queries.md`
Closes #632

* Moved `keys` and `excludeKeys` from objects.md to queries.md

Also:
* Added `excludKeys` to the parameter table
* Added padding to <td> elements in `_normalize.scss`

* Fix typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add keys and excludeKeys options to REST docs RaschidJFR/docs
3 participants
@RaschidJFR @dplewis @TomWFox