Skip to content

Comments

Remove <figure> from JS docs#6128

Merged
sideshowbarker merged 1 commit intomdn:mainfrom
wbamberg:remove-figure-js
Jun 19, 2021
Merged

Remove <figure> from JS docs#6128
sideshowbarker merged 1 commit intomdn:mainfrom
wbamberg:remove-figure-js

Conversation

@wbamberg
Copy link
Collaborator

A read of the conversion report (#5193 (comment)) revealed that we recently had a PR that added <figure> to the JS docs (https://github.com/mdn/content/pull/4762/files). While semantic markup is nice, we don't have a way to express this in GFM, so I'm removing it.

I don't think these examples need a caption, but I added the text as alt text. I hope that's good enough.

@wbamberg wbamberg requested a review from a team as a code owner June 19, 2021 00:51
@wbamberg wbamberg requested review from sideshowbarker and removed request for a team June 19, 2021 00:51
@github-actions
Copy link
Contributor

@sideshowbarker
Copy link
Member

A read of the conversion report (#5193 (comment)) revealed that we recently had a PR that added <figure> to the JS docs (#4762 (files)).

oops — sorry, I was the reviewer for that one… And @mfuji09 was the author — so I reckon we both need to remember we shouldn’t be putting any more figure markup into the docs.

@sideshowbarker sideshowbarker merged commit b39e990 into mdn:main Jun 19, 2021
@wbamberg
Copy link
Collaborator Author

A read of the conversion report (#5193 (comment)) revealed that we recently had a PR that added <figure> to the JS docs (#4762 (files)).

oops — sorry, I was the reviewer for that one… And @mfuji09 was the author — so I reckon we both need to remember we shouldn’t be putting any more figure markup into the docs.

No worries. I don't think it's reasonable to expect everyone to remember all the details of Markdown conversion :) so it's inevitable there will be a bit of rework. And if this had landed as Markdown it would have been OK, but it's better to clean as much as we can.

@hamishwillee
Copy link
Collaborator

@wbamberg Good approach - allows figure captions to easily be recovered, if desired in future, and it carries through to the markdown.

I do like figure captions but only if they are used everywhere in a doc set. I even like the idea "in theory" of mandating the alt text and generating figures from that. Practically speaking though, too many not present or worded poorly for this purpose.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2022
@wbamberg wbamberg deleted the remove-figure-js branch October 15, 2022 17:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants