On Mon, 31 Jan 2022 20:05:45 GMT, Sean Mullan <mul...@openjdk.org> wrote:

> > > Please capitalize "specification" (i.e. "Specification") to be consistent 
> > > with other references in the javadoc. Looks good otherwise.
> > 
> > 
> > OK. Just curious, why we want to use capitalized "specification"? This word 
> > "specification" is not a part of the document title.
> 
> True (although in hindsight we could have added it to the title). However, I 
> think capitalizing when referencing it signifies that it is an important and 
> normative document, similar to when you refer to standard documents even if 
> it is not in title (ex: "The AES Standard"). If we referred to it again in 
> subsequent text, then it is not as necessary, i.e. you could say "This 
> specification includes list of names that are defined as standard ...

Good point!  Thank you!

-------------

PR: https://git.openjdk.java.net/jdk/pull/7290

Reply via email to