Integrated: 4622866: javax.swing.text.Document.remove(int, int) has a misleading picture
Alexey Ivanov
aivanov at openjdk.org
Thu Sep 28 19:31:37 UTC 2023
On Wed, 13 Sep 2023 07:46:50 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:
> The image in the [documentation for `Document.remove`](https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/text/Document.html#remove(int,int)) looks as if the portion between the offsets 6 and 10 is removed. However, the entire region for _‘quick ’_ is highlighted.
>
> I updated the image to mark the start offset 4 and the end offset 10. The new image is in SVG format which looks crisp on modern High DPI displays.
>
> I added a sentence that describes the image, which makes the documentation accessible and clearer.
>
> Also, I marked up references to classes and members with `{@code}`.
>
> Look at the updated version: [`Document.remove` in JDK 22](https://cr.openjdk.org/~aivanov/4622866/api/java.desktop/javax/swing/text/Document.html#remove(int,int)).
This pull request has now been integrated.
Changeset: 73a47f0c
Author: Alexey Ivanov <aivanov at openjdk.org>
URL: https://git.openjdk.org/jdk/commit/73a47f0c4a4f01f62ef55d64120e58535df12623
Stats: 170 lines in 3 files changed: 159 ins; 0 del; 11 mod
4622866: javax.swing.text.Document.remove(int, int) has a misleading picture
Reviewed-by: prr
-------------
PR: https://git.openjdk.org/jdk/pull/15701
More information about the client-libs-dev
mailing list