whatwg/webidl

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

Open

#203 opened on Oct 23, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (204 forks)github user discovery
good first issue⌛⌛⌛ duration:long

Repository metrics

Stars
 (493 stars)
PR merge metrics
 (PR metrics pending)

Description

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 https://github.com/heycam/webidl/pull/198#issuecomment-255540339 and following comments.

Contributor guide

Research direction
Look at the Web IDL specification for other examples where prose algorithms were converted to step based algorithms. Follow the discussion in https://github.com/heycam/webidl/pull/198 for context on the desired format.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of Web IDL specificationUnderstanding of spec formatting conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90