DiffDelta documentation suggests status and newFile are properties, when in fact they are functions
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 704
- PR merge metrics
- No merged PRs in 30d
Description
System information
- node version:
v10.15.3 - npm or yarn version:
npm 6.13.1 - OS/version/architecture:
macOS 10.14.6 - Applicable nodegit version:
0.26.3
The most recent API doc suggest that status and newFile etc of DiffDelta should be properties: https://www.nodegit.org/api/diff_delta/ . Consequently, the TypeScript types also have them as properties, not functions.
However, when I use delta.status, I get a function, not a value, even with the latest release of nodegit. Any idea what the problem could be?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked DiffDelta API documentation and the TypeScript declarations for the status and newFile members. Compare those declarations with the runtime behavior described in the issue; done means the documentation and types consistently represent whether these members are functions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, javascript, node.js, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100