Skip to content

Documentation errors in base.py and test_docs.py #314

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

Closed
marianditt opened this issue Jul 16, 2015 · 3 comments · Fixed by #316
Closed

Documentation errors in base.py and test_docs.py #314

marianditt opened this issue Jul 16, 2015 · 3 comments · Fixed by #316

Comments

@marianditt
Copy link
Contributor

revA..revB → revA...revB (three instead of two dots) base.py, line 467

rorepo is a a Repo instance test_docs.py, line 21

@marianditt marianditt changed the title Minor spelling error "rorepo is a a Repo instance" Documentation errors in base.py and test_docs.py Jul 16, 2015
@Byron Byron added this to the v1.0.2 - Fixes milestone Jul 16, 2015
@Byron
Copy link
Member

Byron commented Jul 16, 2015

Hi,

Thanks for letting me know ! In this case I'd like to encourage you to submit a PullRequest, as it is actually easier to just fix it yourself instead of preparing an issue.

The steps to follow would be along these lines:

  • fork the GitPython repository
  • Add your remote to your local checkout: git remote add mine https://github.com/marianwieczorek/GitPython
  • make the required changes and commit them
  • Push the changes into your fork: git push mine master
  • Click the green PR button in the github interface and follow along to make a PR
  • in the PR's description, you could add closes #314 to close this issue automatically once the PR is merged.

When looking at the bullet points above, it doesn't actually seem easier ... but trust me, it is :).
What do you think ?

Cheers,

@marianditt
Copy link
Contributor Author

I will do it over the weekend. Thanks for responding so quickly. Great work!

@marianditt
Copy link
Contributor Author

... or immediately :-) Sorry for the confusion. I reopen the ticket in order to close it with your PR merge.

@marianditt marianditt reopened this Jul 16, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants