Re: RFR: JDK-8259806: Clean up terminology on the "All Classes" page

2021-06-08 Thread Jonathan Gibbons
On Mon, 31 May 2021 10:06:14 GMT, Hannes Wallnöfer  wrote:

> This is a simple change to replace the "All Classes" with "All Classes and 
> Interfaces" in the heading of and references to the page of the same name.

Marked as reviewed by jjg (Reviewer).

-

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


Re: RFR: JDK-8259806: Clean up terminology on the "All Classes" page

2021-06-07 Thread Hannes Wallnoefer
Yes, the move is from „All Classes“ to „All Classes and Interfaces“. 

This is also the new terminology used in the combined tabbed table in package 
pages, regardless of release.

Hannes


> Am 05.06.2021 um 21:16 schrieb Jonathan Gibbons :
> 
> Up until recently, we used
> 
> Types (now Classes and Interfaces)
> Annotation Type (now Annotation Interface)
> Enum (now Enum Class)
> Record (now Record Class)
> 
> The general decision has been to use the older terms consistent with the 
> usage throughout the documentation for the older releases.
> 
> I guess you have a corner case here, where you are fixing "Classes" (IIRC) 
> and I guess it is "weird" to be retroactively changing it to deprecated 
> terminology like "Types" even if it would be more consistent, especially when 
> the new term is more accurate even for older releases.
> 
> -- Jon
> 
> On 6/4/21 11:57 PM, Hannes Wallnöfer wrote:
>> On Thu, 3 Jun 2021 17:09:21 GMT, Jonathan Gibbons  wrote:
>> 
>>> Maybe I'm fighting a losing battle on this one, but the current policy is 
>>> to generate the correct new terminology for recent releases and the older 
>>> terminology for older releases, to try and stay consist within the release.
>>> 
>>> The mapping is handled semi-automatically in 
>>> `HtmlDoclet.getResourceKeyMapper`, line 130. As a general rule, if you're 
>>> changing terminology, you should at least be updating the mapping as well.
>> Is "Classes and Interfaces" part of the "new terminology"? I thought 
>> "classes and interfaces" would be the correct term for anything living in a 
>> .class file, regardless of release.
>> 
>> -
>> 
>> PR: https://git.openjdk.java.net/jdk/pull/4270



Re: RFR: JDK-8259806: Clean up terminology on the "All Classes" page

2021-06-05 Thread Jonathan Gibbons

Up until recently, we used

Types (now Classes and Interfaces)
Annotation Type (now Annotation Interface)
Enum (now Enum Class)
Record (now Record Class)

The general decision has been to use the older terms consistent with the 
usage throughout the documentation for the older releases.


I guess you have a corner case here, where you are fixing "Classes" 
(IIRC) and I guess it is "weird" to be retroactively changing it to 
deprecated terminology like "Types" even if it would be more consistent, 
especially when the new term is more accurate even for older releases.


-- Jon

On 6/4/21 11:57 PM, Hannes Wallnöfer wrote:

On Thu, 3 Jun 2021 17:09:21 GMT, Jonathan Gibbons  wrote:


Maybe I'm fighting a losing battle on this one, but the current policy is to 
generate the correct new terminology for recent releases and the older 
terminology for older releases, to try and stay consist within the release.

The mapping is handled semi-automatically in `HtmlDoclet.getResourceKeyMapper`, 
line 130. As a general rule, if you're changing terminology, you should at 
least be updating the mapping as well.

Is "Classes and Interfaces" part of the "new terminology"? I thought "classes and 
interfaces" would be the correct term for anything living in a .class file, regardless of release.

-

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


Re: RFR: JDK-8259806: Clean up terminology on the "All Classes" page

2021-06-04 Thread Hannes Wallnöfer
On Thu, 3 Jun 2021 17:09:21 GMT, Jonathan Gibbons  wrote:

> Maybe I'm fighting a losing battle on this one, but the current policy is to 
> generate the correct new terminology for recent releases and the older 
> terminology for older releases, to try and stay consist within the release.
> 
> The mapping is handled semi-automatically in 
> `HtmlDoclet.getResourceKeyMapper`, line 130. As a general rule, if you're 
> changing terminology, you should at least be updating the mapping as well.

Is "Classes and Interfaces" part of the "new terminology"? I thought "classes 
and interfaces" would be the correct term for anything living in a .class file, 
regardless of release.

-

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


Re: RFR: JDK-8259806: Clean up terminology on the "All Classes" page

2021-06-03 Thread Jonathan Gibbons
On Mon, 31 May 2021 10:06:14 GMT, Hannes Wallnöfer  wrote:

> This is a simple change to replace the "All Classes" with "All Classes and 
> Interfaces" in the heading of and references to the page of the same name.

Maybe I'm fighting a losing battle on this one, but the current policy is to 
generate the correct new terminology for recent releases and the older 
terminology for older releases, to try and stay consist within the release.

The mapping is handled semi-automatically in `HtmlDoclet.getResourceKeyMapper`, 
line 130.  As a general rule, if you're changing terminology, you should at 
least be updating the mapping as well.

-

Changes requested by jjg (Reviewer).

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


RFR: JDK-8259806: Clean up terminology on the "All Classes" page

2021-05-31 Thread Hannes Wallnöfer
This is a simple change to replace the "All Classes" with "All Classes and 
Interfaces" in the heading of and references to the page of the same name.

-

Commit messages:
 - JDK-8259806: Clean up terminology on the "All Classes" page

Changes: https://git.openjdk.java.net/jdk/pull/4270/files
 Webrev: https://webrevs.openjdk.java.net/?repo=jdk&pr=4270&range=00
  Issue: https://bugs.openjdk.java.net/browse/JDK-8259806
  Stats: 29 lines in 10 files changed: 5 ins; 3 del; 21 mod
  Patch: https://git.openjdk.java.net/jdk/pull/4270.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/4270/head:pull/4270

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