nodegit / nodegit/nodegit

DiffList is not returned

Open
#1,359 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
5.8k
Forks
704
PR merge metrics
No merged PRs in 30d

Description

it seems that both Diff.treeToTree and Tree#diff fail to return a DiffList, but instead return a Diff object.

the documentation states that they should, so i'm wondering - is DiffList not supported anymore? was it replaced by another type?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the tree diff documentation and examples/diff-commits.js, then trace Diff.treeToTree and Tree#diff to compare their documented and actual return types. Confirm whether DiffList is still supported or has been replaced, and update the documentation or issue resolution so the supported behavior and returned type are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, javascript, node.js
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.