parse-community / Parse-SDK-Android

The Android SDK for Parse Platform

https://parseplatform.org/

Other

1.88k stars 739 forks source link

docs: update documentation for setLimit method #1148

Closed cyb3rko closed 2 years ago

cyb3rko commented 2 years ago

New Pull Request Checklist

[x] I am not disclosing a vulnerability.
[ ] I am creating this PR in reference to an issue.

Issue Description

As I was using setLimit I realized that setting a negative limit does not work anymore as it defaults to 100 anyways. I looked it up in the web documentation and found this:

You can limit the number of results with setLimit. By default, results are limited to 100. In the old Parse hosted backend, the maximum limit was 1,000, but Parse Server removed that constraint

So I quickly updated the documentation, I hope it fits.

Approach

Well, ...

TODOs before merging

[ ] Add tests
[x] Add changes to documentation (guides, repository pages, in-code descriptions)
[x] A changelog entry is created automatically using the pull request title (do not manually add a changelog entry)

parse-github-assistant[bot] commented 2 years ago

Thanks for opening this pull request!

❌ Please check all required checkboxes at the top, otherwise your pull request will be closed.
⚠️ Remember that a security vulnerability must only be reported confidentially, see our Security Policy. If you are not sure whether the issue is a security vulnerability, the safest way is to treat it as such and submit it confidentially to us for evaluation.

azlekov commented 2 years ago

Hey @cyb3rko, nice findings!

I know your changes are small but may I ask you to open an issue associated with this PR? You can use it also and check some additional JavaDoc - it would be great.

Looking forward, Assen

codecov[bot] commented 2 years ago

Codecov Report

Merging #1148 (9d7a183) into master (7d0faa3) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##             master    #1148   +/-   ##
=========================================
  Coverage     66.81%   66.81%           
  Complexity     2249     2249           
=========================================
  Files           121      121           
  Lines          9892     9892           
  Branches       1332     1332           
=========================================
  Hits           6609     6609           
  Misses         2771     2771           
  Partials        512      512

Impacted Files	Coverage Δ
parse/src/main/java/com/parse/ParseQuery.java	`76.99% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update fd1d1da...9d7a183. Read the comment docs.

mtrezza commented 2 years ago

@L3K0V can this be merged?

azlekov commented 2 years ago

Yes @mtrezza

cyb3rko commented 2 years ago

@L3K0V Sorry, I could not find time for this until now. I think now it's too late to open an issue for this, right?

parseplatformorg commented 2 years ago

🎉 This change has been released in version 3.0.1