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.

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

Listing enumerated values for deprecated attributes #28684

Closed
estelle opened this issue Aug 21, 2023 · 5 comments
Closed

Listing enumerated values for deprecated attributes #28684

estelle opened this issue Aug 21, 2023 · 5 comments
Labels
Content:HTML Hypertext Markup Language docs

Comments

@estelle
Copy link
Member

estelle commented Aug 21, 2023

MDN URL

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table

What specific section or headline is this issue about?

Deprecated attributes

What information was incorrect, unhelpful, or incomplete?

In some deprecated attributes we list the enumerated values. In others we don't. @EzioMercer made a very valid point in a PR to add the enumerated values for the deprecated frame attribute.

See #28399 (comment)

Section: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table#deprecated_attributes

What did you expect to see?

consistency

should we list all the deprecated values? Should we omit them all. If some and not others, do we have a rationale?

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

@estelle estelle added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Aug 21, 2023
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs and removed Content:HTML Hypertext Markup Language docs labels Aug 21, 2023
@Josh-Cena Josh-Cena added the Content:HTML Hypertext Markup Language docs label Aug 21, 2023
@EzioMercer
Copy link

In my opinion, if something is deprecated but still widely supported, it should be described as if it weren't deprecated, but if something is deprecated and not widely supported, it should be removed or described very shortly for historic reasons

@bsmth
Copy link
Member

bsmth commented Aug 24, 2023

This could be converted to a discussion, but adding new content about deprecated features doesn't seem useful beyond historical reasons, so from an editorial perspective I would freeze any additions to these, even for the sake of consistency. I'd lean more towards what we're doing with others ('described very shortly for historic reasons'):

- `deprecated_attr` {{Deprecated_inline}}

  - : Description of this attr. To achieve a similar effect, use the {non-deprecated alternative}.

@bsmth bsmth removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Aug 24, 2023
@hamishwillee
Copy link
Collaborator

Yes, I would move to a discussion. FWIW I don't think it makes sense to invest in deprecated content. So yes, you might add a short description to the non-deprecated alternative but I wouldn't pad out a full document.

Content removal has a policy that derives from BCD. Essentially it happens 2 years after a deprecated feature is removed from all browsers in our supported set.

@EzioMercer
Copy link

@hamishwillee How can I found the discussion of this issue?

@hamishwillee
Copy link
Collaborator

@EzioMercer It hasn't been moved. If it had, it the issue would "become" a discussion. I think it would be up to @estelle to do so if she thinks it worthwhile.

I would not feel forced to put much effort into something that was deprecated, for consistency or otherwise.

  • I would ensure there was a BCD entry and possibly also an interface entry so that there is some record on MDN that people shouldn't use the property/method/class.
  • I wouldn't create a full page, for a property though. It is valid to do so, but simply not a priority.
  • For the same reason I wouldn't delete such a page. It does no harm to have and choosing to remove it would not be a priority.

@mdn mdn locked and limited conversation to collaborators Aug 28, 2023
@estelle estelle converted this issue into a discussion Aug 28, 2023
@estelle estelle reopened this Sep 19, 2023
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Sep 19, 2023
@Josh-Cena Josh-Cena closed this as not planned Won't fix, can't repro, duplicate, stale Sep 20, 2023
@bsmth bsmth removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Feb 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:HTML Hypertext Markup Language docs
Projects
None yet
Development

No branches or pull requests

5 participants