nodegit / nodegit/nodegit

`Signature` and `Time` incorrectly has their prototype methods flagged as instance variables

Open
#1,235 4 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

If you look at the online documentation for Signature and Time, you will see that both types have a few instance variables. However, if you look at the actual generated signature.cc and time.cc files, you will see that those are actually prototype methods and not instance variables defined on the JavaScript object.

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

Compare the online Signature and Time documentation with the generated signature.cc and time.cc files mentioned in the report. Trace how the prototype methods are classified in the generated output, then update the documentation so those members are represented accurately. Done means both linked API pages match the generated JavaScript behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, javascript, node.js
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.