esnet / esnet/react-timeseries-charts

Provide comprehensive documentation for all props.

Open
#493 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
876
Forks
279
PR merge metrics
No merged PRs in 30d

Description

# ❔Question

**Provide your question, code sample Or other information that will help in solving here**

#### Your Environment
| Software | Name/Version|
| ---------------- | ---------- |
| react-timeseries-charts | 0.16.1
| Browser | IE Edge, Chrome
| Operating System | Window X

How can I find the function signtaure for the YAxis `yScale` prop? The jsDoc only says `@type {Function}`. This does not tell anyone anything about the acceptable parameters and return value for this props. I can find any example of this usage. My chart is display Y-Axis with duplicate values. There does not seem to be a way to solve this issue either.

Contributor guide

Open the contributing guide

Research direction

Start at the YAxis yScale prop's existing jsDoc, which currently identifies it only as a Function, and inspect the surrounding prop documentation. Done should include usable signatures, accepted parameters, return values, and examples for yScale and the other component props requested by the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.