docs: fix copy-paste javadoc and typos in comments - #189
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix 11 documentation and comment defects across 3 files. No functional changes.
src/main/java/com/jfrog/ide/common/utils/PackageFileFinder.java— four javadoc summaries were copy-paste duplicates that described the wrong thing:getNpmPackagesFilePairs: "Get package.json directories and their directories" -> "Get package.json files and their parent directories"@return FileVisitResult.CONTINUE or FileVisitResult.SKIP_SUBTREE respectfully->respectively(x2)src/main/java/com/jfrog/ide/common/ci/CiManagerBase.java— subject/verb agreement in the producer-consumer javadoc, plus "produce-consumer job" -> "producer-consumer job" and "artifactory" -> "Artifactory".src/main/java/com/jfrog/ide/common/npm/NpmTreeBuilder.java— "Errors occurred during building" -> "while building".The
PackageFileFindergroup is the substantive one: the four getters were documented as returning directories when they return file/parent pairs, and three of them named the wrong file entirely.Comments and javadoc only.