Fixed Issue #53#56
Open
RaevLogic wants to merge 1 commit intonodegit:masterfrom
RaevLogic:Fix-issue-#53
Open
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'.
Member
|
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. |
Author
|
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. |
Member
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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'.