matplotlib / matplotlib/matplotlib.github.com
Canonicalization for 're'-inherited methods
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 29
- Forks
- 62
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
In 3.4.0, the docs for some `Axes` methods (`pick`, `pickable`, `get_picker`, `set_picker`, `get_contains`, `set_contains`) were removed. This is because the docs are inherited from the `Artist` methods.
Sphinx automatically switches all references when generated the docs, but our redirect/canonicalization script here doesn't recognize it. Instead, it thinks these methods were last documented in 3.3.4 and points there.
We should decide if we want to point to the new location (and figure out if it's possible), and do so.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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 o script de redirecionamento/canonização e compare o tratamento que ele dá aos métodos herdados de Artist com as referências geradas pelo Sphinx. Verifique como os métodos de Axes são representados após a remoção da documentação na versão 3.4.0. Está concluído quando o script apontar esses métodos para sua localização canônica atual ou registrar claramente que isso não é possível.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100