Skip to content

8328848: Inaccuracy in the documentation of the -group option #25212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hns
Copy link
Member

@hns hns commented May 13, 2025

Please review a documentation fix in the javadoc man page to document that the -group option can be used with packages or modules depending on documented code.

Although the help output of the javadoc tool already included this fact I replaced the abstract term "elements" with "packages or modules" to make it a bit more concrete.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8328848: Inaccuracy in the documentation of the -group option (Bug - P4)(⚠️ The fixVersion in this issue is [25] but the fixVersion in .jcheck/conf is 26, a new backport will be created when this pr is integrated.)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/25212/head:pull/25212
$ git checkout pull/25212

Update a local copy of the PR:
$ git checkout pull/25212
$ git pull https://git.openjdk.org/jdk.git pull/25212/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25212

View PR using the GUI difftool:
$ git pr show -t 25212

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/25212.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented May 13, 2025

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented May 13, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk bot changed the title JDK-8328848: Inaccuracy in the documentation of the -group option 8328848: Inaccuracy in the documentation of the -group option May 13, 2025
@openjdk openjdk bot added the rfr Pull request is ready for review label May 13, 2025
@openjdk
Copy link

openjdk bot commented May 13, 2025

@hns The following label will be automatically applied to this pull request:

  • javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@mlbridge
Copy link

mlbridge bot commented May 13, 2025

Webrevs

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 10, 2025

@hns This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply issue a /touch or /keepalive command to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
javadoc [email protected] rfr Pull request is ready for review
Development

Successfully merging this pull request may close these issues.

1 participant