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

Spec: Fix algorithm declarations #147

Merged

Conversation

dmcardle
Copy link
Contributor

@dmcardle dmcardle commented Jul 25, 2024

The Bikeshed Documentation (dated 8 March 2024) says, "Algorithms can be explicitly indicated in your markup by putting the algorithm attribute on a container element or a heading" 1.

Through trial and error, I discovered that algorithm-specific markup is not generated when you write <dfn algorithm>. Instead, the <dfn> tag must be wrapped in something like <div algorithm>.

This change has at least two positive results:

  1. Local variables are no longer declared in the global scope!
  2. We can now click on local variables and they are highlighted in pretty colors.

Preview | Diff

@dmcardle dmcardle force-pushed the dmcardle-spec-algorithm branch 2 times, most recently from 9c23648 to 8ccaed2 Compare July 26, 2024 14:28
@dmcardle
Copy link
Contributor Author

@alexmturner PTAL!

I'm not sure how exactly the Shared Storage monkey patches should be marked up, but there's an Issue tracking that in spec.bs.

Copy link
Collaborator

@alexmturner alexmturner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, definitely an improvement! Mainly just needs a rebase (and hopefully that'll fix the presubmit too)

@dmcardle dmcardle force-pushed the dmcardle-spec-algorithm branch from 8ccaed2 to 676ad00 Compare August 6, 2024 17:57
The Bikeshed Documentation (dated 8 March 2024) says, "Algorithms can be
explicitly indicated in your markup by putting the algorithm attribute
on a container element or a heading" [1].

Through trial and error, I discovered that algorithm-specific markup is
not generated when you write <dfn algorithm>. Instead, the <dfn> tag
must be wrapped in something like <div algorithm>.

This change has at least two positive results:

1. Local variables are no longer declared in the global scope!
2. We can now click on local variables and they are highlighted in
   pretty colors.

[1]: https://speced.github.io/bikeshed/#var-and-algorithms
@dmcardle dmcardle force-pushed the dmcardle-spec-algorithm branch from 676ad00 to d106166 Compare August 6, 2024 17:59
@dmcardle
Copy link
Contributor Author

dmcardle commented Aug 6, 2024

@alexmturner PTAL!

@dmcardle
Copy link
Contributor Author

Hey Alex, PTAL :)

Copy link
Collaborator

@alexmturner alexmturner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@alexmturner alexmturner merged commit 80fbc0f into patcg-individual-drafts:main Aug 19, 2024
1 check passed
github-actions bot added a commit that referenced this pull request Aug 19, 2024
SHA: 80fbc0f
Reason: push, by alexmturner

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
dmcardle added a commit to dmcardle/private-aggregation-api that referenced this pull request Aug 19, 2024
This adds a missing return step to the algorithm definition, adds an
explicit instruction to throw when encryption fails, and attempts to
clarify our commentary on RFC9180.

Followup to patcg-individual-drafts#147
dmcardle added a commit to dmcardle/private-aggregation-api that referenced this pull request Aug 22, 2024
This adds a missing return step to the algorithm definition, adds an
explicit instruction to throw when encryption fails, and attempts to
clarify our commentary on RFC9180.

Followup to patcg-individual-drafts#147
alexmturner pushed a commit that referenced this pull request Aug 22, 2024
This adds a missing return step to the algorithm definition, adds an
explicit instruction to throw when encryption fails, and attempts to
clarify our commentary on RFC9180.

Followup to #147
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