5.3.8. Modifying Queries: unclear reference to "custom methods" [DATAJPA-1793]

[spring-projects-issues]

Chealer opened DATAJPA-1793 and commented

Section 5.3.8. Modifying Queries ends with:

The @Modifying annotation is only relevant in combination with the @Query annotation. Derived query methods or custom methods do not require this Annotation.

I do not understand what this considers as a "custom method".

I suggest to either define what custom methods are or to use different terminology

---

Affects: 2.3.4 (Neumann SR4)

Reference URL: https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.modifying-queries

Backported to: 2.3.5 (Neumann SR5), 2.2.11 (Moore SR11)

[spring-projects-issues]

Jens Schauder commented

This is referring to https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repositories.custom-implementations

Adding a link to that section is probably a good idea

[spring-projects-issues]

Chealer commented

Thank you Jens, I see.

How was this resolved? I see that the quoted sentences are unchanged. However, I notice there is already a link to the section mentioned by Jens not long before (at the start of the section with the unclear reference). It would still clarify to either rephrase the sentence, add another link to the relevant section, define custom methods somewhere, or mention custom methods by name in the section about them

[spring-projects-issues]

Jens Schauder commented

I resolved it with introducing the term "custom method" explicitly. a99a087

This way searching for the term if it isn't immediately clear will yields useful results.
If you'd like to see further changes please open a new ticket and a PR