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

Docs should not point to Spring Data / JPA docs to explain Micronaut APIs #2938

Open
mikehearn opened this issue May 12, 2024 · 2 comments
Open

Comments

@mikehearn
Copy link

Issue description

Some of the JavaDocs and guides are a bit lazy and say things like "A repository interface for performing CRUD (Create, Read, Update, Delete). This is a blocking variant and is largely based on the same interface in Spring Data, however includes integrated validation support" which is great if you happen to already know Spring Data but is not useful if you don't.

Another example: https://micronaut-projects.github.io/micronaut-data/latest/guide/#sqlAssociationMapping

@mikehearn
Copy link
Author

Another example:

https://micronaut-projects.github.io/micronaut-data/latest/api/io/micronaut/transaction/annotation/TransactionalEventListener.html

What does "transaction aware event listener" actually mean. The description is repeated in javadoc and user guide but it's never explained how exactly a transaction aware event listener differs from a normal one. Presumably it means it runs inside the transaction instead of outside it?

@mikehearn
Copy link
Author

Another one: https://micronaut-projects.github.io/micronaut-data/latest/api/io/micronaut/transaction/TransactionDefinition.html

This is a fork of Spring's PlatformTransactionManager modernizing it to use enums, SLF4J and decoupling from Spring. Interface that defines Spring-compliant transaction properties. Based on the propagation behavior definitions analogous to EJB CMT attributes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: No status
Development

No branches or pull requests

2 participants