libgit2 / pygit2

Python bindings for libgit2
https://www.pygit2.org/
Other
1.58k stars 382 forks source link

Mismatch of signature and example in docs #1230

Open JanczarKurek opened 10 months ago

JanczarKurek commented 10 months ago

As of now the documentation states in an example that a branch can be created via

repo.branches.local.crate("name-for-a-branch")

see https://github.com/libgit2/pygit2/blob/2accdf97ded8c3b777465e22c4e779692562fa9f/docs/branches.rst?plain=1#L36 but the signature of actual create function is different and requires specifying a commit https://github.com/libgit2/pygit2/blob/2accdf97ded8c3b777465e22c4e779692562fa9f/pygit2/repository.py#L1635