Better docstrings for geojson attributes
Open
Nobody has claimed this yet.
documentation
feature
P2
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 28
Description
We provide some geojson attributes but it's not obvious from our docstrings what can/can't be passed. This causes issues especially for LLMs trying to generate Plotly charts with geojson attributes, and frequent hallucination.
Contributor guide
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
Start by locating the geojson attribute definitions and reading their current docstrings. Identify which values can and cannot be passed, then update the documentation so those supported inputs are explicit and verify that the descriptions cover the geojson attributes mentioned in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- data-visualization, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100