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

Event page: Add syntax section, remove table #10431

Merged
merged 1 commit into from
Nov 10, 2021
Merged

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Nov 10, 2021

Summary

This PR demonstrates how an event page would look like if we add a syntax section, and remove the tabular information box.

Motivation

Better readability and usefulness of event pages.
Consistency with other reference page types.

I'm not yet sure if this is the best way to represent the information.
"Event type" seems quite analog to say "Return value" of method pages, so I believe making this its own heading is useful.

The syntax box is a first attempt, open to feedback to make it more useful.

"Cancelable" seems to be something that can be mentioned in the summary and doesn't necessarily need to stand on its own.

Thoughts?

@Elchi3 Elchi3 requested a review from a team as a code owner November 10, 2021 14:08
@Elchi3 Elchi3 requested review from jpmedley and removed request for a team November 10, 2021 14:08
@github-actions github-actions bot added the Content:WebAPI Web API docs label Nov 10, 2021
@github-actions
Copy link
Contributor

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Web/API/XRLightProbe/reflectionchange_event
Title: XRLightProbe: reflectionchange event
on GitHub

No new external URLs

@jpmedley jpmedley merged commit 0d78979 into mdn:main Nov 10, 2021
@Elchi3 Elchi3 deleted the event-page branch November 10, 2021 17:46
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants