-
Notifications
You must be signed in to change notification settings - Fork 28
cover the documentation linking options in release notes #167
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
base: master
Are you sure you want to change the base?
Conversation
|
👋 Welcome back calnan! A progress list of the required criteria for merging this PR into |
|
@calnan This change now passes all automated pre-integration checks. After integration, the commit message for the final commit will be: You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been no new commits pushed to the As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@irisclark) but any other Committer may sponsor as well. ➡️ To flag this PR as ready for integration with the above commit message, type |
Webrevs
|
|
src/guide/release-notes.md
Outdated
| **Linking to the Java documentation** | ||
|
|
||
| * the linking options defined in JavaDoc [MarkDown](https://openjdk.org/jeps/467#Links) are supported. | ||
| * links to the JDK tools is supported. To differentiate between `[JarSigner]` the class, and `[jarsigner]` the tool, the tool reference should be in all lowercase. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be nice if "JDK tools" was a link to the tools page. I know it's version specific, but the JDK 25 page should be good enough for a few years :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you mean [JDK tools] should be a link to the tools page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, in the sentence "links to the JDK tools is supported."
| * Method names do not need to be prefixed with their class name if they are unique within the JDK, for example '[getTotalGcCpuTime()]'. Where there are multiple methods with the same name, a plain reference to the method can be achieved with '[enquoteIdentifier][Statement.enquoteIdentifier]' | ||
| * Links of the form `[NumberFormat.setStrict]`, `[NumberFormat.setStrict(boolean)]`, `[NumberFormat.setStrict(true)]`, `[ofFileChannel(FileChannel channel, long offset, long length)]` are supported with any of the separators `[.]`, `[#]` and `[::]`. | ||
| * If a link cannot be found then the string will be rendered as if it had been enclosed in back-ticks and, in the EA release notes only, the string "(link not found)" will be added. | ||
| * For notes of the type `rn-removed` if a link is not found then it will be looked for in the JavaDoc of the previous release family. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the Guide's "RN Labels" section, you use "RN-Remove" as the name of the label. Should the case match? Also, suggest adding link to the Guides' definition of the label.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch Iris! The case should match. Also it should be [RN-Remove]{.jbs-value}
added an explanation on the support of JavaDoc like links and the automatic linking of JBS IDs
Progress
Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/guide.git pull/167/head:pull/167$ git checkout pull/167Update a local copy of the PR:
$ git checkout pull/167$ git pull https://git.openjdk.org/guide.git pull/167/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 167View PR using the GUI difftool:
$ git pr show -t 167Using diff file
Download this PR as a diff file:
https://git.openjdk.org/guide/pull/167.diff
Using Webrev
Link to Webrev Comment