Re: [jakarta.ee-spec.committee] convention for class names in specs?

[Bill Shannon <bill.shannon@xxxxxxxxxx>]

Ok, early returns are leaning towards fixed width font.  Let's hear from
some more people!  (I suppose I should put this out to the community list.)

Are we really voting to make our specs *less* readable?

I don't suppose anyone wants to go so far as to say that every mention of
a class name ought to be a hyperlink to the javadocs for that class?
(Please, no.)

Scott Stark wrote on 1/17/20 10:00 AM:
> I prefer that code elements use the fixed width font wherever they
> appear, but do agree this does tend to make the main text less
> readable.
> 
> On Fri, Jan 17, 2020 at 2:02 AM Bill Shannon <bill.shannon@xxxxxxxxxx> wrote:
>>
>> What's our preferred convention for use of class names in spec documents?
>>
>> Should class names (and other Java programming language elements) appear
>> in a fixed width font in the document?
>>
>> Or should they use the same font as the surrounding text?
>>
>> (This is ignoring blocks of code, which I believe should always be in a
>> fixed width font.)
>>
>> The "pro" is that using a fixed width font makes it clear that this is
>> a Java class name being referred to.
>>
>> The "con" is that it clutters up the text making it harder to read with
>> lots of font changes.
>>
>> Comments?
>> _______________________________________________
>> jakarta.ee-spec.committee mailing list
>> jakarta.ee-spec.committee@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
>> https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee
>>
> 
> _______________________________________________
> jakarta.ee-spec.committee mailing list
> jakarta.ee-spec.committee@xxxxxxxxxxx
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee
>