jakartaee / jakartaee/jsonb-api

JsonbAdapter Javadocs should clarify handling of null

Open
#277 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
95
Forks
41
Avg merge
1d 6h
Merged PRs (30d)
35

Description

The Javadocs of `JsonbAdapter` should clarify whether...
* ...it is allowed to pass `null` as a parmeter (so the implementor knows whether this case is to be *handled*)
* ...it is allowed to return `null` as a return value (so the implementor knows whether implementing this is *legal*)

Contributor guide

Open the contributing guide

Research direction

Start at the JsonbAdapter declaration and review its existing Javadocs. Clarify whether implementations may receive null parameters and whether they may return null, so the documented contract explicitly covers both cases.

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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.