Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
#3,361 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
lua
領域
documentation

調査の方向性

まず lua/nvim-tree/api/tree/ 配下の get_nodes() の実装から始めて、実際に何を返すのかを確認し、次に *nvim_tree.api.tree.get_nodes()* というヘルプテキストがどこから来るのかを特定する — 生成されたヘルプファイル(おそらく doc/nvim-tree-lua.txt)と、それを生成するスクリプトまたはアノテーション。そこで戻り型の記述を修正し、その後 API のアノテーションとヘルプファイルを grep して他の Node/Node[] の使用箇所を調べ、それぞれを実装と照合する。ヘルプが実際の戻り値と一致し、ドキュメントを再生成しても自分の修正以外の差分が出ないときに完了。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Lua
スター
8.7k
フォーク
639
平均マージ
8時間 25分
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nvim-tree/nvim-tree.lua のほかの issue

nvim-tree/nvim-tree.lua の issue をすべて見る

似ている issue

Lua の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。