platform icon indicating copy to clipboard operation
platform copied to clipboard

V24.4 alpha 22 testing: "ConfirmDialog" component should not add unsupported methods

Open bennewi opened this issue 1 year ago • 6 comments

Describe the bug

A number of methods were added to the ConfirmDialog component in V24.4 that are marked as "Deprecated, not supported since 24.4"

This creates an ambiguous and confusing situation.

Expected-behavior

Better to either add the methods and support them or don't add the methods.

Reproduction

(seen in api docs)

System Info

(seen in api docs)

bennewi avatar Apr 17 '24 08:04 bennewi

Those do not look like new methods, but inherited methods, which use can break intended use of ConfirmDialog. Hence I think deprecation is a good way to warn about them.

TatuLund avatar Apr 17 '24 08:04 TatuLund

formal java api docs could make that clear. This doesn't have to block beta

bennewi avatar Apr 17 '24 09:04 bennewi

The change is intentional. See https://github.com/vaadin/flow-components/pull/5519 where it was implemented.

web-padawan avatar Apr 17 '24 10:04 web-padawan

I understand, but anyone reading java api docs won't get the explanation. Would be better to add because it looks rather strange at the moment.

bennewi avatar Apr 17 '24 11:04 bennewi

@web-padawan So what is needed for closing this issue? add some explanation in javadocs?

manolo avatar May 16 '24 06:05 manolo

Yes, we probably could clarify Javadoc (although it already describes why these methods are unsupported).

web-padawan avatar May 16 '24 07:05 web-padawan