Skip to content

docs: fix copy-paste javadoc and typos in comments - #189

Open
Avicennasis wants to merge 1 commit into
jfrog:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix copy-paste javadoc and typos in comments#189
Avicennasis wants to merge 1 commit into
jfrog:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

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"
  • the yarn.lock, build.gradle and go.mod getters each carried that same package.json sentence -> each now names its own file type
  • @return FileVisitResult.CONTINUE or FileVisitResult.SKIP_SUBTREE respectfully -> respectively (x2)
  • "Skip sub directories without permissions" -> "subdirectories"

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 PackageFileFinder group 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.

@coderabbitai

coderabbitai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: abb97ed1-7cd1-4056-a1a9-1d5b50ed7d21


Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant