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 updates #125

Merged
merged 5 commits into from
Oct 10, 2024
Merged

Editorial updates #125

merged 5 commits into from
Oct 10, 2024

Conversation

mikewest
Copy link
Member

@mikewest mikewest commented Oct 7, 2024

This PR pulls together some small editorial updates that remove hard-coded links (thereby shifting to Infra and HTML in some places), and adjusts some variable names for future extensibility. Nothing crazy.

I've broken the changes out into a few distinct commits in the hopes that that makes this simpler to review.

WDYT, @mozfreddyb?


Preview | Diff

Updating links in a few ways, none of which (intentionally) change
normative meaning:

1.  Linking to HTML, not HTML5.
2.  Dropping hard-coded links that are now properly exported.
3.  Updating grammar to link to CSP.
Rather than linking to (very) old implementation reports, we
can instead render live data from WPT instead.
This patch cleans up example code by using `<xmp>` instead of
`<pre>` to make things more readable, and by adding syntax highlighting.
If we'd like to support non-hash algorithms, changing variable
names in the parsing function will reduce the complexity of
future diffs.
@mozfreddyb
Copy link
Collaborator

Personally, I don't believe the new variable names in the algorithm are more useful, but I will admit that the previous once weren't better. Thank you for all of the changes. It's nice that we can have syntax highlighting now :)

@mozfreddyb mozfreddyb merged commit 0f7980a into main Oct 10, 2024
2 checks passed
@mozfreddyb mozfreddyb deleted the editorial-updates branch October 10, 2024 08:25
github-actions bot added a commit that referenced this pull request Oct 10, 2024
SHA: 0f7980a
Reason: push, by mozfreddyb

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@mikewest
Copy link
Member Author

Personally, I don't believe the new variable names in the algorithm are more useful

They'll make the diff in https://wicg.github.io/signature-based-sri/#parsing simpler. :)

Thanks for the review!

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.

2 participants