micronaut-projects / micronaut-projects/micronaut-data
Docs: Javadocs for CrudRepository don't explain what exceptions are thrown
Open
Nobody has claimed this yet.
type: docs
- Dominant language
- Java
- Stars
- 482
- Forks
- 229
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 32
Description
Feature description
CrudRepository.save throws an exception if the primary key is duplicated, for example, but there's no discussion in the Javadocs about what exceptions to expect, and no checked exceptions either.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the CrudRepository Javadocs and inspect the save method and its implementation or tests to identify the exceptions raised for duplicate primary keys. Update the Javadocs to explain the expected exceptions, then run the relevant repository tests to confirm the documentation matches behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100