Provide API or document how to allow/disallow blocking inside constructors
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.5k
- Forks
- 95
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
There is no guidance I could find on how to allow/disallow blocking in a constructor or static initializer. There is one test that shows how to do it for a static initializer but it would be nicer if it was easier to find. One option could be a dedicated method, e.g. allowBlockingCallsInsideConstructor(String classname), or otherwise provide guidance in the Javadoc on allowBlockingCallsInside and a mention on the Customizations page.
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 with example/src/test/java/com/example/StaticInitTest.java to understand the existing static-initializer approach. Then review the Javadoc for allowBlockingCallsInside and docs/customization.md. Done means that users can find clear guidance for allowing or disallowing blocking in constructors or static initializers, or that the proposed dedicated API is specified if documentation alone is insufficient.
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
- 35/100