Document PagesInterface::getNbPages() and Page::$nbPages - #382
Draft
koriym wants to merge 1 commit into
Draft
Conversation
The pagination example showed only `count()` and the Page properties (total/current/hasNext/hasPrevious/maxPerPage). Add the new `PagesInterface::getNbPages()` and the `Page::$nbPages` property to the example, in both the JA and EN database.media.md, so readers can obtain the total number of pages without recomputing `ceil(count / perPage)` by hand.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
Walkthrough英語版と日本語版のdatabase.media.mdマニュアルにおいて、PagesInterfaceのgetNbPages()メソッドによる総ページ数取得に関する説明とコード例を追加。count()の遅延実行の説明も拡張され、$page->nbPagesの参照例が追記された。 Changesページネーションドキュメント更新
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or 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
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.
Summary
The pagination example in
database.media.md(JA and EN) showed onlycount()and thePageproperties (total/current/hasNext/hasPrevious/maxPerPage). This adds the new page-count API to the example so readers can obtain the total number of pages without recomputingceil(count / perPage)by hand.Changes
manuals/1.0/ja/database.media.mdmanuals/1.0/en/database.media.mdBoth files:
getNbPages()in the lead paragraph.$pages->getNbPages()to the code example.$page->nbPagesto thePageproperty list.Depends on
This documents APIs that are not yet released. Merge after the following library PRs land and are released:
Page::$nbPagesPagesInterface::getNbPages()If either library PR changes its API during review, this manual PR should be updated to match before merging.
Draft until the library PRs are merged and released.
Summary by CodeRabbit