Skip to content

Document PushInfoList - #1522

Merged
Byron merged 1 commit into
gitpython-developers:mainfrom
skinitimski:feature/doc-pushinfolist
Dec 29, 2022
Merged

Document PushInfoList#1522
Byron merged 1 commit into
gitpython-developers:mainfrom
skinitimski:feature/doc-pushinfolist

Conversation

@skinitimski

@skinitimskiskinitimski commented Dec 28, 2022

Copy link
Copy Markdown
Contributor

#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
@ByronByron added this to the v3.1.30 - Bugfixes milestone Dec 29, 2022
@Byron

Copy link
Copy Markdown
Member

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:mainDec 29, 2022
@skinitimski
skinitimski deleted the feature/doc-pushinfolist branch December 29, 2022 15:23
Sign up for freeto 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.

2 participants

@skinitimski@Byron