DATACMNS-1601 - Improving the JavaDoc of the CrudRepository. #412
Conversation
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
Clarifying expectations and guarantees or lack thereof.
Document throws on save(…). Align documentation for reactive repositories.
schauder
commented
Oct 30, 2019
| */ | ||
| Mono<T> findById(Publisher<ID> id); | ||
|
|
||
| /** | ||
| * Returns whether an entity with the id exists. | ||
| * Returns whether an entity with the given {@code id} exists. |
There was a problem hiding this comment.
Suggested change
| * Returns whether an entity with the given {@code id} exists. | |
| * Returns whether an entity with the given {@literal id} exists. |
| @@ -108,20 +109,29 @@ | |||
| Flux<T> findAll(); | |||
|
|
|||
| /** | |||
| * Returns all instances with the given IDs. | |||
| * Returns all instances of the type {@code T} with the given IDs. | |||
There was a problem hiding this comment.
Suggested change
| * Returns all instances of the type {@code T} with the given IDs. | |
| * Returns all instances of the type {@literal T} with the given IDs. |
| */ | ||
| Flux<T> findAllById(Iterable<ID> ids); | ||
|
|
||
| /** | ||
| * Returns all instances of the type with the given IDs supplied by a {@link Publisher}. | ||
| * Returns all instances of the type {@code T} with the given IDs supplied by a {@link Publisher}. |
There was a problem hiding this comment.
Suggested change
| * Returns all instances of the type {@code T} with the given IDs supplied by a {@link Publisher}. | |
| * Returns all instances of the type {@literal T} with the given IDs supplied by a {@link Publisher}. |
| */ | ||
| Maybe<T> findById(Single<ID> id); | ||
|
|
||
| /** | ||
| * Returns whether an entity with the given id exists. | ||
| * Returns whether an entity with the given {@code id} exists. |
There was a problem hiding this comment.
Suggested change
| * Returns whether an entity with the given {@code id} exists. | |
| * Returns whether an entity with the given {@literal id} exists. |
There was a problem hiding this comment.
I'm stopping commenting on this, since it is easier to find and fix within the IDE.
| * | ||
| * @param id must not be {@literal null}. | ||
| * @return {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||
| * @throws IllegalArgumentException if {@code id} is {@literal null}. | ||
| * @return {@link Single} emitting {@literal true} if an entity with the given id exists, {@literal false} otherwise. |
There was a problem hiding this comment.
Ok it now gets really nitpicky but shouldn't it be TRUE since it is the constant from the wrapper type, not the primitive?
If you agree there are more places like this.
| * @return {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||
| * @throws IllegalArgumentException if {@code id} is {@literal null}. | ||
| * @return {@link Single} emitting {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||
| * @throws IllegalArgumentException in case the given {@code id} is {@literal null}. |
There was a problem hiding this comment.
Suggested change
| * @throws IllegalArgumentException in case the given {@code id} is {@literal null}. | |
| * @throws IllegalArgumentException in case the given {@literal id} is {@literal null}. |
| * @return {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||
| * @throws IllegalArgumentException if {@code id} is {@literal null} | ||
| * @return {@link Single} emitting {@literal true} if an entity with the given id exists, {@literal false} otherwise. | ||
| * @throws IllegalArgumentException in case the given {@link Single id} is {@literal null}. |
There was a problem hiding this comment.
This should be either {@literal IllegalArgument} or {@link IllegalArgument}
Same in many other places.
| */ | ||
| Flowable<T> findAll(); | ||
|
|
||
| /** | ||
| * Returns all instances of the type with the given IDs. | ||
| * Returns all instances of the type {@code T} with the given IDs. |
There was a problem hiding this comment.
We are mixing IDs and ids and I think it should be {@literal ids} referring to the parameter name.
| */ | ||
| Flowable<T> findAllById(Iterable<ID> ids); | ||
|
|
||
| /** | ||
| * Returns all instances of the type with the given IDs. | ||
| * Returns all instances of the type {@code T} with the given IDs supplied by a {@link Flowable}. |
mp911de
pushed a commit
that referenced
this pull request
Oct 30, 2019
Clarifying expectations and guarantees or lack thereof. Original pull request: #412.
mp911de
added a commit
that referenced
this pull request
Oct 30, 2019
Document throws on save(…). Align documentation for reactive repositories. Original pull request: #412.
mp911de
pushed a commit
that referenced
this pull request
Oct 30, 2019
Clarifying expectations and guarantees or lack thereof. Original pull request: #412.
mp911de
added a commit
that referenced
this pull request
Oct 30, 2019
Document throws on save(…). Align documentation for reactive repositories. Original pull request: #412.
mp911de
pushed a commit
that referenced
this pull request
Oct 30, 2019
Clarifying expectations and guarantees or lack thereof. Original pull request: #412.
mp911de
added a commit
that referenced
this pull request
Oct 30, 2019
Document throws on save(…). Align documentation for reactive repositories. Original pull request: #412.
mp911de
added a commit
that referenced
this pull request
Oct 30, 2019
Document throws on save(…). Align documentation for reactive repositories. Original pull request: #412.
mp911de
added a commit
that referenced
this pull request
Oct 30, 2019
Document throws on save(…). Align documentation for reactive repositories. Original pull request: #412.
mp911de
added a commit
that referenced
this pull request
Oct 30, 2019
Document throws on save(…). Align documentation for reactive repositories. Original pull request: #412.
|
Updated to consistent literal usage. That's merged, polished, and backported now. |
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.
Clarifying expectations and guarantees or lack thereof.
https://jira.spring.io/browse/DATACMNS-1601