open-feature / open-feature/java-sdk

Audit usage of @inheritDoc

Open
#424 2 comments 0 reactions 0 assignees View on GitHub
contribfest good first issue help wanted
Dominant language
Java
Stars
128
Forks
61
Avg merge
5h 57m
Merged PRs (30d)
26

Description

We're using `@inheritDoc` to avoid writing javadoc, but that's not well founded in some cases. Audit the usage of it and ensure our docs are reasonable.

Contributor guide

Open the contributing guide

Research direction

Start by searching the repository for every use of @inheritDoc and review the surrounding Javadoc for whether inherited documentation is appropriate. The work is done when each use has reasonable, intentional documentation, but the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.