Skip to content

docs: Fix incorrect type in docs for Parse.Query.containedIn and Parse.Query.notContainedIn #1784

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
Merged
merged 3 commits into from
Feb 21, 2023
Merged

docs: Fix incorrect type in docs for Parse.Query.containedIn and Parse.Query.notContainedIn #1784

merged 3 commits into from
Feb 21, 2023

Conversation

richardgroves
Copy link
Contributor

@richardgroves richardgroves commented Feb 20, 2023 •
edited by mtrezza
Loading

Pull Request

Issue

Closes: #1783

Approach

Documentation and method parameter type updated for Parse.Query.containedIn and Parse.Query.notContainedIn

Tasks

  • Add changes to documentation (guides, repository pages, code comments)

@parse-github-assistant
Copy link

parse-github-assistant bot commented Feb 20, 2023 •
edited
Loading

Thanks for opening this pull request!

@richardgroves
Copy link
Contributor Author

Thanks for opening this pull request!

  • ❌ Please edit your post and use the provided template when creating a new pull request. This helps everyone to understand your post better and asks for essential information to quicker review the pull request.

I'm not sure which bit of the template I didn't use, AFAICS I filled in each section.

@mtrezza
Copy link
Member

mtrezza commented Feb 20, 2023 •
edited
Loading

All good, I removed the "Fixes #1783" at the top, that's what the "Closes:" is for. And there's a bug in the bot I guess because this is a new template, let me fix that real quick...

@mtrezza mtrezza changed the title Fix type doc & def for containedIn and notContainedIn docs: Fix API docs for ParseQuery.containedIn and ParseQuery.notContainedIn Feb 20, 2023
@mtrezza mtrezza changed the title docs: Fix API docs for ParseQuery.containedIn and ParseQuery.notContainedIn docs: Fix incorrect type in docs for ParseQuery.containedIn and ParseQuery.notContainedIn Feb 20, 2023
mtrezza
mtrezza requested changes Feb 20, 2023
View reviewed changes
Copy link
Member

@mtrezza mtrezza left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests fail because in JSDos it's Array. It may be more correct to specify the exact types that can be passed, unless really any type can be passed, including objects, array, etc.

Array<null|undefined|String|Number|Boolean> is just a guess

richardgroves and others added 2 commits February 20, 2023 17:06
@richardgroves @mtrezza
Update src/ParseQuery.js
4f6f27d 
Better type def in doc

Co-authored-by: Manuel <[email protected]>
Signed-off-by: Richard Groves <[email protected]>
@richardgroves @mtrezza
Update src/ParseQuery.js
a0bb24b 
Better type def in doc

Co-authored-by: Manuel <[email protected]>
Signed-off-by: Richard Groves <[email protected]>
@richardgroves
Copy link
Contributor Author

The tests fail because in JSDos it's Array. It may be more correct to specify the exact types that can be passed, unless really any type can be passed, including objects, array, etc.

Array<null|undefined|String|Number|Boolean> is just a guess

I'm not 100% sure what types can be in the array, and whether an array of items has to be of a single type or can have mixed contents. Would specifying the type list limit it to an array of homogenous types?

I know I have arrays of objects (or object pointers internally) so 'object' would have to be in the list of allowed types.

@mtrezza
Copy link
Member

mtrezza commented Feb 20, 2023 •
edited
Loading

Would specifying the type list limit it to an array of homogenous types? I know I have arrays of objects (or object pointers internally) so 'object' would have to be in the list of allowed types.

Yes. So let's go with Array<*> I guess. Let's see whether the CI passes this time...

@richardgroves richardgroves changed the title docs: Fix incorrect type in docs for ParseQuery.containedIn and ParseQuery.notContainedIn docs: Fix incorrect type in docs for Parse.Query.containedIn and Parse.Query.notContainedIn Feb 20, 2023
@codecov
Copy link

codecov bot commented Feb 20, 2023

Codecov Report

Base: 99.90% // Head: 99.90% // No change to project coverage 👍

Coverage data is based on head (b1b4f73) compared to base (5ca4bbe).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head b1b4f73 differs from pull request most recent head a0bb24b. Consider uploading reports for the commit a0bb24b to get more accurate results

Additional details and impacted files 
@@           Coverage Diff           @@
##            alpha    #1784   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files          61       61           
  Lines        6103     6103           
  Branches     1482     1482           
=======================================
  Hits         6097     6097           
  Misses          6        6
Impacted Files Coverage Δ
src/ParseQuery.js 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

mtrezza
mtrezza approved these changes Feb 21, 2023
View reviewed changes
Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mtrezza mtrezza merged commit db18547 into parse-community:alpha Feb 21, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.1.0-beta.1

@parseplatformorg parseplatformorg added the state:released-beta Released as beta version label Mar 1, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.1.0-alpha.1

@parseplatformorg parseplatformorg added the state:released-alpha Released as alpha version label Mar 1, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.1.0

@parseplatformorg parseplatformorg added the state:released Released as stable version label May 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mtrezza mtrezza mtrezza approved these changes

Assignees
No one assigned
Labels
state:released Released as stable version state:released-alpha Released as alpha version state:released-beta Released as beta version
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Parse.Query.containedIn documentation issue
3 participants
@richardgroves @mtrezza @parseplatformorg