inab / inab/oeb-visualizations

Document `xrange` property of `accessibilityPlot`

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
HTML
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Document xrange property of accessibilityPlot.

xrange: {
    /*
    xrange is the range of the x axis in ms.
    */
    type: Array,
    required: false
},

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

Start at the accessibilityPlot definition and inspect how its existing properties are documented. Document the xrange property with its Array type and the stated meaning of the x-axis range in milliseconds; the change is complete when this property is covered consistently with the surrounding documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.