api doc: nvim_tree.api.tree.get_nodes() returns explorer, not a node array

Fechada Para iniciantes
#3,361 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
lua
Domínio
documentation

Direção de pesquisa

Comece pela implementação de get_nodes() em lua/nvim-tree/api/tree/ para confirmar o que ela realmente retorna, depois localize de onde vem o texto de ajuda *nvim_tree.api.tree.get_nodes()* — o arquivo de ajuda gerado (provavelmente doc/nvim-tree-lua.txt) e o script ou as anotações que o geram. Corrija a descrição do tipo de retorno lá e então procure nas anotações da API e no arquivo de ajuda outros usos de Node/Node[] e verifique cada um contra sua implementação. Concluído quando a ajuda corresponder ao valor de retorno real e a regeneração da documentação não produzir diff além da sua correção.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation

Incorrect:

get_nodes()                                   *nvim_tree.api.tree.get_nodes()*
    Retrieve a hierarchical list of all the nodes.

    Return: ~
        (`nvim_tree.api.Node[]`)

API and help should be reviewed to ensure all other Node usages are correct.

Linguagem predominante
Lua
Estrelas
8.7k
Forks
642
Merge médio
1d 4min
PRs com merge (30d)
11

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de nvim-tree/nvim-tree.lua

Todas as issues de nvim-tree/nvim-tree.lua

Issues semelhantes

Mais issues de Lua

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.