On Fri, 11 Apr 2025 14:38:27 GMT, Andy Goryachev <ango...@openjdk.org> wrote:

>> Normally, it is not a best practice to use the bug ID of the bug being 
>> fixed. In this case, because the fix is really a workaround for a GHA 
>> environment issue, it seems OK. The comment belongs in the GHA script, so I 
>> added it there.
>
> Normally, yes, but in some cases the context is important.  Yes, one can look 
> at the git history and get the JBS from there (unless the code was moved or 
> merged), but it seems to be an easier way to provide the answer on the "why 
> was this change made" than write the _War and Peace_ in the comments.  In 
> this case it's perfect - we have good comments and the JBS for anyone who 
> wants to know more.

A good example of what should _not_ be done is something along the lines of 
ComboBoxListViewSkin:158:

        // Fix for JDK-8115587. Additional code related to this bug is further 
below.
        this.listView.setManaged(false);
        getChildren().add(listView);
        // -- end of fix

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

PR Review Comment: https://git.openjdk.org/jfx/pull/1770#discussion_r2039702371

Reply via email to