jcabi / jcabi/jcabi-github

Misleading Javadoc on RtCommit constructor parameters

Open Beginner friendly
#1,935 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
307
Forks
144
Avg merge
1d 22h
Merged PRs (30d)
14

Description

In `src/main/java/com/jcabi/github/RtCommit.java`, the Javadoc on the public constructor at lines 40-45 describes the wrong concepts. The `@param repo` reads `Owner of this comment` but the parameter is a `Repo`, not a comment owner, and this class is `RtCommit` (a commit, not a comment). The `@param sha` reads `Number of the get`, which is meaningless — the parameter is the commit SHA hash, matching the `hash` field documented just above at line 36.

Both lines look like copy-paste residue from a comment-related class. They mislead anyone reading the API documentation and they propagate into the published Javadoc.

The fix is to rewrite those two lines as `@param repo Repository containing this commit` and `@param sha Commit SHA hash`, mirroring the wording of the field comment at line 36.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open src/main/java/com/jcabi/github/RtCommit.java and inspect the public constructor Javadoc at lines 40-45 alongside the hash field comment at line 36. Update the repo and sha parameter descriptions to identify the repository containing the commit and its SHA hash, then verify the generated Javadoc contains the corrected wording.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.