Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
moniuch opened this issue Oct 6, 2024 · 1 comment · May be fixed by angular/material.angular.io#1274
Open

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

moniuch opened this issue Oct 6, 2024 · 1 comment · May be fixed by angular/material.angular.io#1274
Labels
area: material.angular.io docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent

Comments

@moniuch
Copy link

moniuch commented Oct 6, 2024

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 moniuch added docs This issue is related to documentation needs triage This issue needs to be triaged by the team labels Oct 6, 2024
@naaajii
Copy link
Contributor

naaajii commented Oct 6, 2024

it shows a little popup saying when it will be deprecated on hover.

Image

@crisbeto crisbeto added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent area: material.angular.io and removed needs triage This issue needs to be triaged by the team labels Oct 8, 2024
naaajii added a commit to naaajii/material.angular.io that referenced this issue Oct 14, 2024
@naaajii
feat: show deprecated related information in material/tooltip
d2c1e1f 
previously we weren't showing any other information other than `breaking-change` for deprecated fields, this commit adds a component that protrays information regarding deprecation in tooltips rather than `title` attribute

closes angular/components#29839
@naaajii naaajii linked a pull request Oct 14, 2024 that will close this issue
Open
naaajii added a commit to naaajii/material.angular.io that referenced this issue Oct 14, 2024
@naaajii
feat: show deprecated related information in material/tooltip
33d57e7 
previously we weren't showing any other information other than `breaking-change` for deprecated fields, this commit adds a component that protrays information regarding deprecation in tooltips rather than `title` attribute

closes angular/components#29839
naaajii added a commit to naaajii/material.angular.io that referenced this issue Oct 21, 2024
@naaajii
feat: show deprecated related information in material/tooltip
122e253 
previously we weren't showing any other information other than `breaking-change` for deprecated fields, this commit adds a component that protrays information regarding deprecation in tooltips rather than `title` attribute

closes angular/components#29839
naaajii added a commit to naaajii/material.angular.io that referenced this issue Oct 28, 2024
@naaajii
feat: show deprecated related information in material/tooltip
7886880 
previously we weren't showing any other information other than `breaking-change` for deprecated fields, this commit adds a component that protrays information regarding deprecation in tooltips rather than `title` attribute

closes angular/components#29839
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: material.angular.io docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: show deprecated related information in material/tooltip naaajii/material.angular.io
3 participants
@moniuch @crisbeto @naaajii