Skip to content

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

Closed
angular/material.angular.io
#1274
@moniuch

Description

@moniuch

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3An issue that is relevant to core functions, but does not impede progress. Important, but not urgentarea: material.angular.iodocsThis issue is related to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions