Skip to content

Documentation enhancement: Separate examples of methods with special parameters and methods without #3268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hdvlp opened this issue Apr 15, 2025 · 1 comment · May be fixed by #3269
Open
Assignees

Comments

@Hdvlp
Copy link

Hdvlp commented Apr 15, 2025

The documentation of Limiting Query Results can be enhanced with the clarification and comment from schauder.

Current situation:
The examples with parameters inside brackets such as List<User> findByLastname(Limit limit); and the examples without parameters inside brackets such as User findFirstByOrderByLastnameAsc(); appear in the same box of examples.

Potential enhancement:
To be more obvious, it could be done like this:

I imagine a potential change could be: (There could be a better way, but this is what I can think of right now.)

Create two boxes of examples:
Box A:
Examples without parameters in brackets.

Box B:
Examples with parameters in brackets.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 15, 2025
@schauder
Copy link
Contributor

That is kind of the opposite of what I intended. Instead of separating these categories out they should get better mixed, in order to make clear that filtering by property and limiting by method name or special argument are orthogonal concerns.

I'll move this to commons, where the documentation we are talking about resides and will provide a PR.

@schauder schauder transferred this issue from spring-projects/spring-data-jpa Apr 15, 2025
schauder added a commit that referenced this issue Apr 15, 2025
Examples for limitin queries with and without a property argument are now better mixed.
This makes it more clear that limiting and filtering by property are orthogonal concerns.

Closes #3268
@schauder schauder linked a pull request Apr 15, 2025 that will close this issue
schauder added a commit that referenced this issue Apr 15, 2025
Examples for limiting queries with and without a property argument are now better mixed.
This makes it more clear that limiting and filtering by property are orthogonal concerns.

Closes #3268
@schauder schauder self-assigned this Apr 15, 2025
@schauder schauder added in: documentation and removed status: waiting-for-triage An issue we've not yet triaged labels Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants