Skip to content

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

Closed
@marianditt

Description

@marianditt
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

Activity

changed the title [-]Minor spelling error "rorepo is a a Repo instance"[/-] [+]Documentation errors in base.py and test_docs.py[/+] on Jul 16, 2015
added this to the v1.0.2 - Fixes milestone on Jul 16, 2015
Byron

Byron commented on Jul 16, 2015

@Byron
Member

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

marianditt commented on Jul 16, 2015

@marianditt
ContributorAuthor

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

marianditt

marianditt commented on Jul 16, 2015

@marianditt
ContributorAuthor

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

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      Participants

      @Byron@marianditt

      Issue actions

        Documentation errors in base.py and test_docs.py · Issue #314 · gitpython-developers/GitPython