Skip to content
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

Fix documentation about NoSQL database behavior. #963

Merged
merged 9 commits into from
Feb 17, 2025
Merged

Conversation

otaviojava
Copy link
Contributor

It fixes: NoSQL databases need to be allowed to raise errors for function that the database type is not capable o

Changes

Fixes:

@otaviojava otaviojava requested a review from njr-11 February 6, 2025 19:24
@@ -146,17 +146,33 @@ default Stream<T> stream() {
* Returns the total number of elements across all pages of query results, if the
* {@link #pageRequest()} specified that {@linkplain PageRequest#requestTotal the
* total should be retrieved from the database}.
*
* <p><strong>Note for NoSQL databases:</strong> Not all NoSQL databases support counting the total
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we perhaps use @apiNote for this?

@otaviojava
Copy link
Contributor Author

@njr-11 Thanks for the notes; I have a different way to see the reuse of exceptions. Could you check it and let me know your thoughts?

Copy link
Contributor

@njr-11 njr-11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See review comments. There is no good solution for NoSQL, so I'll mostly agree to the behavior that Otavio wants, but I still see this as a more undesirable way for a provider to handle things, so I don't want to see significant portions of the JavaDoc for these methods being cluttered up with it and distracting from more core usage.

@otaviojava otaviojava merged commit 93fce64 into main Feb 17, 2025
4 checks passed
@otaviojava otaviojava deleted the fix-java-doc-nosql branch February 17, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

NoSQL databases need to be allowed to raise errors for function that the database type is not capable of
3 participants