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

Turn 1-line prose algorithms into step-based algorithms for readability. #203

Open
tobie opened this issue Oct 23, 2016 · 1 comment
Open
Labels
⌛⌛⌛ duration:long There goes your week-end good first issue Ideal for someone new to a WHATWG standard or software project

Comments

@tobie
Copy link
Collaborator

tobie commented Oct 23, 2016

This is especially an issue with the IDL to ES conversion algorithms.

For example, turn:

When the \[[DefineOwnProperty]] internal method of a [=named properties object=] is called,
it must return <emu-val>false</emu-val>.

into:

<div algorithm="to invoke the internal [[DefineOwnProperty]] method of named properties object">

    When the \[[DefineOwnProperty]] internal method of a [=named properties object=] is called,
    the following steps are taken:

    1.  Return <emu-val>false</emu-val>.
</div>

For context, see discussion in #198 (comment) and following comments.

@tobie tobie added ⌛⌛⌛ duration:long There goes your week-end wontfix good first issue Ideal for someone new to a WHATWG standard or software project and removed wontfix labels Oct 23, 2016
@littledan
Copy link
Collaborator

I'm not sure if the current form is less readable. I am wondering if we should just put a <div algorithm> box around them to make it prettier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⌛⌛⌛ duration:long There goes your week-end good first issue Ideal for someone new to a WHATWG standard or software project
Development

No branches or pull requests

3 participants
@tobie @littledan and others