search

vaadin / platform

Vaadin platform 10+ is a Java web development platform based on Vaadin web components. If you don't know to which repository your bug report should be filed, use this and we'll move it to the right one.
https://vaadin.com
510 stars 76 forks source link

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

Open bennewi opened 1 month ago

bennewi commented 1 month ago

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)

TatuLund commented 1 month ago

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.

bennewi commented 1 month ago

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

web-padawan commented 1 month ago

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

bennewi commented 1 month ago

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.

manolo commented 2 days ago

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

web-padawan commented 2 days ago

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