◐ Shell
clean mode source ↗

Fixed Issue #53 by RaevLogic · Pull Request #56 · nodegit/nodegit.github.com

@RaevLogic

Fixed the documentation on both the API page and the Object page. Corrected two Object function names, from 'string2type' and 'type2string', to 'string2Type' and 'type2String'.

Fixed the documentation on both the API page and the Object page. Corrected two Object function names, from 'string2type' and 'type2string', to 'string2Type' and 'type2String'.

@implausible

I think the intent of this repo is to generate the markdown files from the nodegit compile step, and changing the markdown files manually is not the right process for updating documentation errors. I think they would be wiped away the next time we generate the documentation. Correct me if I'm wrong @tbranyen.

@RaevLogic

Ah, so I probably misunderstood here. This was my first time working with Jekyll and Ruby, so definitely my mistake. If @tbranyen agrees about the nodegit compile step, I'll figure out what that is and correct this for everyone.

@tbranyen

This file gets updated by this repo's write api docs function. It'll need to be changed in nodegit, which generates the descriptor object, and then generate the docs here. Check out the README here to link them.