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.
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 reporeadsOwner of this commentbut the parameter is aRepo, not a comment owner, and this class isRtCommit(a commit, not a comment). The@param shareadsNumber of the get, which is meaningless — the parameter is the commit SHA hash, matching thehashfield 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 commitand@param sha Commit SHA hash, mirroring the wording of the field comment at line 36.