RFR: clarify how to set the affects versions [v5]
calnan
duke at openjdk.org
Fri Mar 1 14:02:06 UTC 2024
On Thu, 29 Feb 2024 10:14:49 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:
>> calnan has updated the pull request incrementally with one additional commit since the last revision:
>>
>> updates from feedback
>
> src/guide/jbs-jdk-bug-system.md line 212:
>
>> 210: * In addition to the version where the bug was found, take special care to also investigate if the bug affects mainline.
>> 211: * See [Indicating what releases an issue is applicable to](#indicating-what-releases-an-issue-is-applicable-to) for more details.
>> 212: * For enhancements the [Affects Version]{.jbs-field} should be empty, unless you feel that it is only relevant to a particular release family, and should not go into a future mainline release.
>
> To me, the comma before “unless” is redundant, conditional clauses after a main clause don't usually have commas before the conjunction that introduces it; however, this conditional clause is very long… Still, I wouldn't put a comma there.
>
> With the comma before “and”, I feel the second conditional needs _a subject_ “it”; and removing “you feel that” makes the sentence shorter and clearer:
> Suggestion:
>
> * For enhancements the [Affects Version]{.jbs-field} should be empty, unless it is only relevant to a particular release family, and (unless) it should not go into a future mainline release.
>
> To make the sentence even clearer, you may repeat the conjunction: “_unless_ it should…”, I put it in parentheses in the suggestion.
agree that the feel part should go as well as the comma
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/119#discussion_r1509050544
More information about the guide-dev
mailing list