- Notifications
You must be signed in to change notification settings - Fork24
Fixed Issue #53#56
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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'.
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. |
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. |
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. |
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'.