plotly / plotly/react-plotly.js
Documentation encourages use of literals as props
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.1k
- Forks
- 138
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 4
Description
E.g. in the "Quick Start" section. The problem is that in the "State Management" section we show developers how to "close the loop" and if they use literals as props things will infinitely-loop!
Conclusion: we should scrub our docs and examples of the use of literals :(
See also #87
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the "Quick Start" and "State Management" sections, then inspect the documentation and examples for similar literal props. Confirm the intended guidance with issue #87; the work is done when the documented examples no longer encourage literals that can cause an infinite loop.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100