Better docstrings for geojson attributes
Aberta
Ninguém assumiu esta issue ainda.
documentation
feature
P2
- Linguagem predominante
- JavaScript
- Estrelas
- 18.3k
- Forks
- 2k
- Merge médio
- 2d 12h
- PRs com merge (30d)
- 28
Descrição
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.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece localizando as definições dos atributos geojson e lendo suas docstrings atuais. Identifique quais valores podem e não podem ser passados, depois atualize a documentação para que essas entradas compatíveis estejam explícitas e verifique se as descrições abrangem os atributos geojson mencionados na issue.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript
- Domínio
- data-visualization, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100