gchq / gchq/sleeper

Add missing Javadoc in clients/deploy package

Open
#6,291 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

### Background
Under epic:

- #2092

### Split from:

- #2091

### Description
We'd like to add missing Javadoc for the clients/deploy module.

### Analysis
We can start by removing the Checkstyle suppression for this, for both missingJavadocMethod and missingJavadocType.

Contributor guide

Open the contributing guide

Research direction

Review the clients/deploy package and the Checkstyle configuration entries for missingJavadocMethod and missingJavadocType. Remove the suppressions, document the reported methods and types, and confirm Checkstyle passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.