Commit#getDiff callback is undocumented

オープン
#1,959 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
git, javascript, node.js
領域
api, documentation

調査の方向性

https://www.nodegit.org/api/commit/#getDiff にある Commit#getDiff のドキュメントから始め、ドキュメント化された API エントリとその callback のシグネチャを確認してください。callback のパラメーターと返される promise との関係が明確に説明されるか、API の動作が明らかになれば完了です。

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

説明

The documentation at https://www.nodegit.org/api/commit/#getDiff does not document the callback for getDiff (the parameters it takes, etc.).

Additionally, the API doesn't seem to make sense: It takes a callback and returns a promise. It's unclear what the callback is for in the first place, as it seems to be an odd mix of promise-based and callback-based asynchronicity, which is typically either one or the other.

主要言語
JavaScript
スター
5.8k
フォーク
704
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

nodegit/nodegit のほかの issue

nodegit/nodegit の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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