The Wayback Machine - https://web.archive.org/web/20201225135032/https://github.com/nodegit/nodegit.github.com/pull/56
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

Fixed Issue #53 #56

Open
wants to merge 1 commit into
base: master
from
Open

Fixed Issue #53 #56

wants to merge 1 commit into from

Conversation

@RaevLogic
Copy link

@RaevLogic RaevLogic commented Sep 24, 2018

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
Copy link
Member

@implausible implausible commented Sep 26, 2018

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
Copy link
Author

@RaevLogic RaevLogic commented Sep 26, 2018

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
Copy link
Member

@tbranyen tbranyen commented Sep 26, 2018

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.

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

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.