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

Documentation needs update #1065

Open
christoffertoft opened this issue Sep 30, 2020 · 0 comments
Open

Documentation needs update #1065

christoffertoft opened this issue Sep 30, 2020 · 0 comments

Comments

@christoffertoft
Copy link

@christoffertoft christoffertoft commented Sep 30, 2020

Hi guys, and thanks for a cool project! I find that documentation is sorely lacking in some areas unfortunately.

Under the "Remotes handling" chapter for example, we see this snippet:

empty_repo = git.Repo.init(os.path.join(rw_dir, 'empty'))
origin = empty_repo.create_remote('origin', repo.remotes.origin.url)

there's no indication on how to set up the remote, and judging from this code snippet it's already previously set up? The code doesnt work when I run it in a test script unfortunately.
Maybe creating some simple recipes in the documentation for oft-performed tasks would be an idea?
Like "instantiate a new repo and set up remote". "integrate latest changes to local" "Push dirty state to remote" - you get the idea

I think being super verbose in the documentation helps, both in limiting the number of issues the dev team has to answer and to increase adoption of the library, I think having to go directly to StackOverflow or similar to get answers about basic set up is a sign of lacking documentation:
https://stackoverflow.com/questions/28291909/gitpython-and-ssh-keys
https://stackoverflow.com/questions/41836988/git-push-via-gitpython

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.