oωo (owo-lib)

oωo (owo-lib)

17M Downloads

Add deprecated tooltip for options annotated with @Deprecated

Awakened-Redstone opened this issue · 1 comments

commented

It would be nice to show a Deprecated option message for options annotated with @Deprecated
On my code I show it before the restart required message

For example like this:
image
image

Translation used:

"text.owo.config.deprecated": [
    {
        "text": "",
        "color": "#EB1D36"
    },
    " ",
    {
        "text": "This option is deprecated",
        "color": "gray"
    }
]
commented

After some consultation with the team, we don't think that this is really a good idea for the library itself. The primary reason for this is that it does not tell the user any further information on why this option is deprecated and what they should use instead. This makes for a terrible user experience - you're simply being told that "no, this is bad" without any further explanation.

This then leads to the reason why we don't see this feature as necessary. Because an additional explanation would always have to be provided via the lang file anways (that is, via the option's .tooltip key), you can simply include the deprecation notice with this explanation, and there is no reason to support this in code.

We can however see about incorporating the translation you offered into owo's lang file to make it easy to include via a { "translate": ... } component

Cheers