The Wayback Machine - https://web.archive.org/web/20200916183742/https://github.com/nodegit/nodegit/issues/1734
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

The documentation isnt consistent when requiring the package. #1734

Open
ahtee opened this issue Oct 13, 2019 · 0 comments
Open

The documentation isnt consistent when requiring the package. #1734

ahtee opened this issue Oct 13, 2019 · 0 comments

Comments

@ahtee
Copy link

@ahtee ahtee commented Oct 13, 2019

Documentation update to just the require statements in the docs.

The main page has this:

var Git = require('"nodegit")

While other pages have

var NodeGit = require("nodegit")

Which of these can be used for the whole site? I prefer the full name (var NodeGit) over the shortened version (var Git)

I think the docs can be improved a small bit by being more consistent from just this step, preventing come copy-paste errors or people having multi-imports by accident.

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

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.