On Wed, 19 Apr 2023 14:41:59 GMT, Nir Lisker <nlis...@openjdk.org> wrote:
>> Stuart Marks has updated the pull request incrementally with three >> additional commits since the last revision: >> >> - Remove unnecessary 'final' from a couple places. >> - Clarify ordering of Collection.addAll and Map.putAll; add links to >> encounter order. >> - Make constructors private for several reverse-ordered views. > > I reviewed some of the public documentation and left some comments and > thoughts. As a general remark, the documentation could use [Code > Snippets](https://openjdk.org/jeps/413) to avoid the `<pre>{@code` pattern. > @nlisker OK I've accepted some of the editorial comments, converted code > samples to snippets, etc. However I didn't add markup around every keyword as > `{@code List}` when it's used as an ordinary noun. That's the prevailing > style in this area, at least mine (though there are probably inconsistencies > across the JDK). I find that excessive markup clutters both the marked-up > javadoc and also the visually rendered output. That's fine, I wasn't sure what style you follow. The comments are more suggestions or thought than requests. I'll finish the other half of the docs review so the CSR can be update. ------------- PR Comment: https://git.openjdk.org/jdk/pull/7387#issuecomment-1515972772
