plotly / plotly/plotly.js

Better docstrings for geojson attributes

Aperta
#7,435 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation feature P2
Lingua principale
JavaScript
Stelle
18.3k
Fork
2k
Merge medio
2g 12h
PR unite (30g)
28

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando le definizioni degli attributi geojson e leggendo i relativi docstring attuali. Identifica quali valori possono e non possono essere passati, quindi aggiorna la documentazione in modo che gli input supportati siano esplicitati e verifica che le descrizioni coprano gli attributi geojson menzionati nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
data-visualization, documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.