Better docstrings for geojson attributes
Offen
Dieses Issue hat noch niemand übernommen.
documentation
feature
P2
- Vorherrschende Sprache
- JavaScript
- Sterne
- 18.3k
- Forks
- 2k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 28
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Definitionen der geojson-Attribute zu lokalisieren und ihre aktuellen Docstrings zu lesen. Ermittle, welche Werte übergeben werden können und welche nicht, aktualisiere anschließend die Dokumentation so, dass diese unterstützten Eingaben eindeutig angegeben sind, und überprüfe, dass die Beschreibungen die im Issue erwähnten geojson-Attribute abdecken.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- data-visualization, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100