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

Incorrect documentation for BlameHunk #1958

Open
JC3 opened this issue Dec 12, 2022 · 0 comments
Open

Incorrect documentation for BlameHunk #1958

JC3 opened this issue Dec 12, 2022 · 0 comments

Comments

@JC3
Copy link

JC3 commented Dec 12, 2022

The documentation for BlameHunk at https://www.nodegit.org/api/blame_hunk/ lists all fields as "instance variables".

None of them are instance variables of the specified type. All of them are functions returning the specified type.

The documentation should list them as class methods.

There are a number of other objects besides BlameHunk that have this same error, so I'm presuming it's a consequence of how the documentation is generated.

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

1 participant