Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rcjsuen opened this issue Feb 26, 2017 · 4 comments

Comments

@rcjsuen
Copy link
Member

rcjsuen commented Feb 26, 2017

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.

@saper
Copy link
Collaborator

saper commented Feb 26, 2017

This belongs to the doc repository and is somehow related to the way instance variables are detected (in my opinion this is also related to nodegit/nodegit.github.com#46)

@rcjsuen
Copy link
Member Author

rcjsuen commented Feb 26, 2017

The generated output is in the doc repository but I think the issue is that the input in libgit2-docs.json is flagging those things as instance variables.

      "git_signature",
      {
        "decl": [
          "char * name",
          "char * email",
          "git_time when"
        ],
      "git_time",
      {
        "decl": [
          "git_time_t time",
          "int offset"
        ],

@saper
Copy link
Collaborator

saper commented Feb 26, 2017

maybe, you seem to know more than I do :)

@jmtoball
Copy link
Contributor

jmtoball commented Dec 26, 2017

Any news on this? I assume the type definitions here are also generated from the documentation and that makes working with nodegit in TypeScript a bit cumbersome 😩

The (assumed) underlying issue is not exclusive to Signature either. The methods on BlameHunk also documented as fields.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants