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

Editorial: Put boxes around algorithms #828

Merged
merged 1 commit into from
Sep 25, 2023
Merged

Editorial: Put boxes around algorithms #828

merged 1 commit into from
Sep 25, 2023

Conversation

domfarolino
Copy link
Collaborator

@domfarolino domfarolino commented Sep 25, 2023

This is a readability improvement (related to #646). Some bikeshed specs have these convenient boxes around the algorithms to make it clear when one algorithm/monkey patch starts, and another begins. I think it helps keep your bearings when reading the spec, and adds clear delimiters between sections. See the boxes around the algorithms in https://wicg.github.io/fenced-frame/#fenced-frame-config-mapping-store-a-pending-config for example.


Preview | Diff

@miketaylr
Copy link
Collaborator

nice!

@domfarolino domfarolino merged commit a53bd47 into main Sep 25, 2023
2 checks passed
@domfarolino domfarolino deleted the algo-boxes branch September 25, 2023 15:21
github-actions bot added a commit that referenced this pull request Sep 25, 2023
SHA: a53bd47
Reason: push, by domfarolino

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to MattMenke2/turtledove that referenced this pull request Sep 25, 2023
SHA: a53bd47
Reason: push, by MattMenke2

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit to qingxinwu/turtledove that referenced this pull request Sep 25, 2023
SHA: a53bd47
Reason: push, by qingxinwu

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants