Jon, I’ve updated the webrev with the comments as suggested. I also update the text to hopefully be a bit clearer. It’s also closer to the previous text, and just adds the following:
- mention system properties as searchable items - add example of „j.l.obj“ matching „java.lang.Object“ - Add sentence with reference to search spec New webrev: http://cr.openjdk.java.net/~hannesw/8223252/webrev.01/ New help page: http://cr.openjdk.java.net/~hannesw/8223252/api.01/help-doc.html Hannes > Am 13.11.2019 um 03:00 schrieb Jonathan Gibbons <[email protected]>: > > Hannes, > > It is somewhat weird/non-standard to use resources in this way to create > links, and the decision to put the word "the" outside the link, away from the > content of the link "Javadoc Search Specification" is a bit idiomatic. > > I'd suggest prefixing the resources with comments describing the values that > will be substituted. > > # {0} will be replaced by a link derived from the url and title for the > Javadoc Search Specification > 222 doclet.help.search.spec.body=Refer to the {0} for a full description of > search features. > # The URL for the Javadoc Search Specification. {0} will be replaced by > the JDK version number > > 223 doclet.help.search.spec.url=https://docs.oracle.com/en/java/javase/ > {0}/docs/specs/javadoc/javadoc-search-spec.html > # The title for the Javadoc Search Specification > > 224 doclet.help.search.spec.title=Javadoc Search Specification > -- Jon > > On 11/12/19 2:30 AM, Hannes Wallnöfer wrote: >> Please review: >> >> Bug: >> https://bugs.openjdk.java.net/browse/JDK-8223252 >> >> Webrev: >> http://cr.openjdk.java.net/~hannesw/8223252/webrev.00/ >> >> >> >> New help page: >> http://cr.openjdk.java.net/~hannesw/8223252/api.00/help-doc.html >> >> >> Changes in the „search“ section of the help page: >> >> - mention of searchable system properties >> - mention and example of partial matches (in addition to camel-case) >> - new paragraph with link to search spec on docs.oracle.com >> >> Thanks, >> Hannes >>
