Skip to content

Rename isRequired() method in PaginatorInterface to isPaginationRequired()#151

Merged
vjik merged 1 commit intomasterfrom
rename-is-required
Jan 8, 2024
Merged

Rename isRequired() method in PaginatorInterface to isPaginationRequired()#151
vjik merged 1 commit intomasterfrom
rename-is-required

Conversation

@vjik
Copy link
Member

@vjik vjik commented Jan 8, 2024

Q A
Is bugfix?
New feature?
Breaks BC? ✔️

It's more clear, because paginator used as reader.
For example:

$dataReader->isRequired();
// vs
$dataReader->isPaginationRequired();

@codecov
Copy link

codecov bot commented Jan 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e2fd7e0) 100.00% compared to head (583fcd5) 100.00%.

Additional details and impacted files
@@             Coverage Diff             @@
##              master      #151   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       254       254           
===========================================
  Files             35        35           
  Lines            634       634           
===========================================
  Hits             634       634           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@what-the-diff
Copy link

what-the-diff bot commented Jan 8, 2024

PR Summary

  • Renamed method in PaginatorInterface
    The isRequired() method in PaginatorInterface has been renamed to isPaginationRequired(). This change makes its purpose clearer in the context of its role in pagination.

  • Updated method in KeysetPaginator
    Similarly, the isRequired() method in KeysetPaginator has been renamed to isPaginationRequired(), improving readability and understanding.

  • Adjusted method in OffsetPaginator
    The isRequired() method in OffsetPaginator also has been renamed to isPaginationRequired(). This keeps naming consistent across similar functionality.

Note: These changes in method names contribute not only to better clarity but also promote consistency throughout the codebase.

@vjik vjik requested a review from a team January 8, 2024 07:33
@vjik vjik added the status:code review The pull request needs review. label Jan 8, 2024
@vjik vjik merged commit 408742d into master Jan 8, 2024
@vjik vjik deleted the rename-is-required branch January 8, 2024 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status:code review The pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants