Skip to content

Consider using Ecmarkdown to write the spec algorithms #8

@domenic

Description

@domenic

I am not sure this is worth it; it would primarily be reasonable to entertain if the automated conversion script could do the initial conversion.

Streams writes all of its algorithms ES-style, just like Web IDL. It does this through a two-stage build pipeline where the second stage runs emu-algify.

This allows the algorithms in streams to be nice and concise. In particular, any ECMAScript abstract operations defined either in ES or in the streams spec itself get automatically linked (without <a> tags needed); several other ES-specific terms also get autolinked.

So far I have noticed a couple downsides:

  • Because emu-algify runs after Bikeshed, terms auto-linked by emu-algify do not show up in Bikeshed's appendix of terms used by this specification
  • Mixing in Bikeshed auto-links can sometimes be fragile, although it usually works (as seen by the <a idl> in the above-linked snippet.

These could probably be addressed by working more closely with @tabatkins and @bterlson on integrating Ecmarkdown-for-algorithms into Bikeshed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions