Improve docs of pagination types #483
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The commit includes 2 main changes. + The old one mixes pagination types and paramaters. At first glance, it can be very confusing. So, I change the doc to not mention related parameters at all. And, the parameters will be mentioned in the doc of `t:Flop.pagination_type/0`. + Note that the `nil` is the default value. This tells developers that they don't need to do anything if they want to support all pagination types.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #483 +/- ##
==========================================
- Coverage 87.53% 87.43% -0.11%
==========================================
Files 15 15
Lines 987 931 -56
==========================================
- Hits 864 814 -50
+ Misses 123 117 -6 ☔ View full report in Codecov by Sentry. |
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to improve the docs of pagination types.
These two commits are self-explanatory. Feedback is welcome.