Skip to content

Use Bikeshed’s algorithm construct. #198

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

Merged
merged 12 commits into from
Oct 26, 2016
Merged

Use Bikeshed’s algorithm construct. #198

merged 12 commits into from
Oct 26, 2016

Conversation

tobie
Copy link
Collaborator

@tobie tobie commented Oct 22, 2016

This PR:

  • marks up all algorithms with <div algorithm>,
  • gives a name to those which don't include a <dfn>,
  • turns single step algorithms (e.g. return false) to prose.
  • Fix algorithms that generated Bikeshed warnings (due to missing variables or mistakes in variable names).

This PR is too big to be apprehended as a whole in GitHub, however it's split into explicitly named commits.

The first commit is just a markup change, as shown by its HTML diff.

Every following commit is atomic and addresses a particular issue raised by Bikeshed.


Preview | Diff

Per Commit Preview & Diffs

b6b4453: Preview | Diff w/ Head (2016-10-21 11:03)
8d188f5: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 06:29)
ad0c8fd: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 07:50)
32b176d: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 08:21)
8b14740: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 08:24)
50fc7e9: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 08:39)
aa81166: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 09:11)
735054f: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 10:02)
da785b7: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 12:14)
6c5dd1b: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 12:29)
c442f0e: Preview | Diff w/ Head | Diff w/ Previous (2016-10-23 12:32)
Latest (a605edb): Preview | Diff w/ Head | Diff w/ Previous (2016-10-25 17:13)

@domenic
Copy link
Member

domenic commented Oct 22, 2016

turns single step algorithms (e.g. return false) to prose.

Not a big fan of this personally. Having algorithms always be nice numbered lists helps me immensely when reading and understanding.

@tobie
Copy link
Collaborator Author

tobie commented Oct 22, 2016

turns single step algorithms (e.g. return false) to prose.

Not a big fan of this personally. Having algorithms always be nice numbered lists helps me immensely when reading and understanding.

OK. There's a lot of single step algorithms which are folded into prose, e.g.: most IDL to ES type mappings. Would you want those fixed at some point? I don't care either way, but I'd like consistency in the spec.

@domenic
Copy link
Member

domenic commented Oct 22, 2016

Ah interesting point. I think fixing those would be good, yeah.

@tobie tobie force-pushed the algos branch 2 times, most recently from ad67615 to 366b1da Compare October 23, 2016 09:35
@tobie
Copy link
Collaborator Author

tobie commented Oct 23, 2016

OK, this is now ready to be reviewed.

@marcoscaceres
Copy link
Member

Github can't show all the changes :( You might need to send this in chunks?

@marcoscaceres
Copy link
Member

Actually, nm. Can look at the commits individually.

@tobie
Copy link
Collaborator Author

tobie commented Oct 25, 2016

Folks, it would really help if someone actually reviewed the following commits:

  • 8d188f5 (Replace prose calls to [[Call]] method by Call(args).)
  • ad0c8fd (Fix incorrectly named variables.)
  • 735054f (Fix copy/paste error in map serialiser algorithm.)
  • c442f0e (Fix invoke algorithm.)

These are all bugs in the spec uncovered by using Bikeshed's algorithm construct. It shouldn't take a lot of your time, but would allow me to land this commit before I have to handle a bunch of merge conflicts. Thanks.

@annevk
Copy link
Member

annevk commented Oct 25, 2016

Those four commits look fine to me, but I'd kinda prefer if we used « » over prose-allocation of a List.

@tobie tobie merged commit d433e0a into whatwg:gh-pages Oct 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants