Repository navigation
openIndex(), createCommit() missing from API documentation #634
Description
I expected to find documentation for repository#openIndex() and repository#createCommit() in the API documentation after encountering them in the example code.
These appear to be completely absent from the documentation, which is pretty surprising since they seem like key functionality that appears to have been added way back in or before v0.2.
Activity
[-]openIndex() missing from API documentation[/-][+]openIndex(), createCommit() missing from API documentation[/+]nopnop commentedon Sep 27, 2015
Yes, this is confusing. Related: #197 and #198
Maybe, the examples need to be updated ?
tbranyen commentedon Sep 27, 2015
@vsivsi we auto-generate the documentation on the site, so it's entirely possible they are either missing JSDoc syntax, or we have a bug in the generator. Since they are not manually added, its not like we just forgot to add them.
tbranyen commentedon Sep 27, 2015
https://github.com/nodegit/nodegit/blob/master/lib/repository.js#L22-L25
^^ As we can see here
openIndexis indeed missing JSDoc syntax, which explains why it is omitted from the documentation.rcjsuen commentedon Jan 29, 2017
createCommitis now on the website and theopenIndexfunction has since been removed fromRepository. Can we close this?tbranyen commentedon Jan 29, 2017
Sounds good to me!