Refine parameter and field names to align with PageRequest property names
#2882
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
We mix using page with pageNumber, size with pageSize and sometimes, it makes me confused. And I think pageNumber and pageSize are more clearer. Feel free to close this if there is a reason or we can not change it.
spring-projects-issues
added
the
status: waiting-for-triage
mp911de
reviewed
Jul 20, 2023
| */ | ||
| public AbstractPageRequest(int page, int size) { | ||
| protected AbstractPageRequest(int pageNumber, int pageSize) { |
There was a problem hiding this comment.
We should not change visibility. I'm going to revert this change upon merge.
| @@ -36,13 +37,13 @@ public class PageRequest extends AbstractPageRequest { | |||
| /** | |||
| * Creates a new {@link PageRequest} with sort parameters applied. | |||
| * | |||
| * @param page zero-based page index, must not be negative. | |||
| * @param size the size of the page to be returned, must be greater than 0. | |||
| * @param pageNumber zero-based pageNumber index, must not be negative. | |||
There was a problem hiding this comment.
Whoops, seems too much was changed by the refactoring. I'll align these upon merge.
mp911de
added
type: task
mp911de
changed the title
PageRequest property names
mp911de
added a commit
that referenced
this pull request
Jul 20, 2023
Tweak Javadoc wording, revert visibility changes, add missing Override annotations. See #2882
mp911de
pushed a commit
that referenced
this pull request
Jul 20, 2023
… names. Align parameter naming with properties to not mix using page with pageNumber, size with pageSize names. Closes #2882
mp911de
added a commit
that referenced
this pull request
Jul 20, 2023
Tweak Javadoc wording, revert visibility changes, add missing Override annotations. See #2882
mp911de
pushed a commit
that referenced
this pull request
Jul 20, 2023
… names. Align parameter naming with properties to not mix using page with pageNumber, size with pageSize names. Closes #2882
mp911de
added a commit
that referenced
this pull request
Jul 20, 2023
Tweak Javadoc wording, revert visibility changes, add missing Override annotations. See #2882
|
Thank you for your contribution. That's merged, polished, and backported now. |
|
Hi @mp911de, I think we need to update the release note for Spring Data 2022.0 at https://github.com/spring-projects/spring-data-commons/wiki/Spring-Data-2022.0-(Turing)-Release-Notes, somehow I did not find it there when I was upgrading my service to Spring Boot 3. I think this commit should be considered as breaking change since it may affect many user especially for a downstream service. Wdyt? 🙇 |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
We mix using page with pageNumber, size with pageSize and sometimes, it makes me confused. And I think pageNumber and pageSize are more clearer. Feel free to close this if there is a reason or we can not change it.