components icon indicating copy to clipboard operation
components copied to clipboard

docs-bug(common): The way deprecated symbols are rendered

Open moniuch opened this issue 1 year ago • 1 comments
trafficstars

Documentation Feedback

The docs for material have a general problem with deprecated symbols. Here is just an example of *TreeControl

  1. The word Deprecated on hover suggests through the question mark that there is some explanation behind it (which there is when you look into the TS code), but nothing happens either on hover or on click [it was impossible to capture that cursor in the screenshot]
  2. I think for the sake of clarity, the name of a deprecated symbol should be style using strikethrough, and the explanation + suggestions what to use should immediately follow it, even before the old description. Currently the styling of the Deprecated word doesn't really stand out as much as it should, blends into the body text, IMO.

Image

Affected documentation page

https://material.angular.io/cdk/tree/api#BaseTreeControl

moniuch avatar Oct 06 '24 21:10 moniuch