design-system icon indicating copy to clipboard operation
design-system copied to clipboard

Add deprecation comments to the type declarations

Open didoo opened this issue 4 months ago • 1 comments

:pushpin: Summary

As suggested by @aklkv in this Slack thread we could communicate these deprecation changes "also through dev tools (in addition to documentation and deprecation warnings)".

After discussion with the HDS Engineering team, we decided this is something we can add to our list of things to do, when deprecating an argument.

:hammer_and_wrench: Detailed description

In this PR I have:

  • added a deprecation comment to @text argument in Hds::Dropdown::ListItem::Interactive component

This is the only case where this comment can be applied. All the other deprecations are entire (sub)components so there's no way to add a comment for the entire component.

I've also updated the documentation in Confluence about Deprecation of an API feature of a component


👀 Component checklist

:speech_balloon: Please consider using conventional comments when reviewing this PR.

didoo avatar Oct 02 '24 15:10 didoo