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

Document PushInfoList #1522

Merged

Conversation

skinitimski
Copy link
Contributor

@skinitimski skinitimski commented Dec 28, 2022

#1360 was a great change, but it went undocumented, leading to continued confusion about how to use the new feature.

This PR

  • Adds docstring for PushInfoList so that it will show up in the API search index (currently it is completely absent).
  • Changes type hint of the return value of push to match what is actually returned.
  • Corrects the docstring for return value of push.

@skinitimski skinitimski marked this pull request as ready for review December 28, 2022 20:02
@Byron Byron added this to the v3.1.30 - Bugfixes milestone Dec 29, 2022
@Byron
Copy link
Member

Byron commented Dec 29, 2022

Thanks so much for improving the docs! I will try harder to watch out for issues like these in future. Part of the problem is me doing this from the browser exclusively which only provides a limited view.

@Byron Byron merged commit 5bce9b4 into gitpython-developers:main Dec 29, 2022
@skinitimski skinitimski deleted the feature/doc-pushinfolist branch December 29, 2022 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants