speced / speced/respec

Support fully qualified method name definitions

Open
#3,571 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature request High priority
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Is your feature request related to a problem? Please describe.
Right now, to define, for instance watchPosition() in the Geolocation API in a manner that conforms to the WebIDL spec, one needs to write:

The <dfn>watchPosition</dfn>(|successCallback:PositionCallback|,
          |errorCallback:PositionErrorCallback|, |options:PositionOptions|)
          method steps are:

Describe the solution you'd like
One should just write:

The <dfn>watchPosition(successCallback, errorCallback, options)</dfn> method steps are:

And ReSpec should add in all the types for the arguments (and wrap them in <var> etc).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the issue's current watchPosition() example as the starting input and compare it with the proposed shorthand. Trace ReSpec's existing handling of method definitions; done means the shorthand gains the argument types and wraps arguments in while preserving the method-steps output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.