Skip to content

Webpage examples are not up to date #190

Closed

Description

@kimmobrunfeldt

Examples in http://www.nodegit.org/ front page do not work:

git.repo('.git', function(error, repository) {
    ^
TypeError: Object #<Object> has no method 'repo'
    at Object.<anonymous> (/Users/kimmo/code/personal/git-time-spent/test.js:5:5)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:906:3

Activity

  1. loveencounterflow commented on Jul 22, 2014

    @loveencounterflow

    why has this issue been closed? i get the exact same error when trying out the homepage example (with nodegit 0.1.4 and node 0.10.29). still trying to figure out how to open an existing local repo. those generated docs are quite hard to fathom; also, the example given for Repo.open is apparently from an old version, and when i do Repo.open( route, handler ), the callback would appear to never get called.

  2. gabrielflorit commented on Oct 3, 2014

    @gabrielflorit

    same issue here

  3. johnhaley81 commented on Oct 3, 2014

    @johnhaley81
    Collaborator

    So currently nodegit is in a pretty fluid state. We're trying to upgrade to the latest version of libgit2 and are focusing 100% of our efforts towards that. Once that's done we'll focus on documenting the new methods and types.

  4. maxkorp commented on Oct 3, 2014

    @maxkorp
    Collaborator

    If you follow the link trail (reference to #196 ), you can see the root of the issue, that the docs are out of date. Unfortunately, fixing the docs is not currently a priority :/

    nodegit is undergoing a very large scale refactoring at the moment. We're working towards trying to rapidly expand to near 100% accessability to libgit2, while making it easier to keep updated with newer versions of libgit2. The current implementation time means that adding more libgit2 features to nodegit is really slow, and migrating versions is just as painful.

    As @tbranyen pointed out in the other issue, we're happy to accept any additional help, either with fixing the documentation in the meantime, or with actual implementation.

    Newer docs are here, for what its worth
    http://www.nodegit.org/nodegit/
    Repo: https://github.com/nodegit/nodegit.github.com

  5. gabrielflorit commented on Oct 3, 2014

    @gabrielflorit

    cool - thanks for the prompt reply guys

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions