Skip to content

Improve messsages in the bundled signatures so they are actionable #220

@vlsi

Description

@vlsi

Here's jdk-unsafe:

@defaultMessage Uses default locale
java.lang.String#toLowerCase()
java.lang.String#toUpperCase()

I suggest adding the recommended action into the message.

@defaultMessage Use String#toLowerCase(Locale) to pass locale explicitly. For instance: .toLowerCase(Locale.ROOT)
java.lang.String#toLowerCase()
@defaultMessage Use String#toUpperCase(Locale) to pass locale explicitly. For instance: .toUpperCase(Locale.ROOT)
java.lang.String#toUpperCase()

An interesting case is

@defaultMessage Uses default locale or time zone
java.util.Calendar#<init>()

In fact, it uses both default locale and default timezone.
I added a timezone, rerun the check, and forbidden-apis was unhappy again on the same line, which was confusing for me for a couple of seconds.

WDYT?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions