Skip to content

doc: warn against using init_repository() to open a repository. #1356

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 19, 2025
Merged

doc: warn against using init_repository() to open a repository. #1356

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pygit2/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ def init_repository(
The *workdir_path*, *description*, *template_path*, *initial_head* and
*origin_url* are all strings.

If a repository already exists at *path*, it may be opened successfully but
you must not rely on that behavior and should use the Repository
constructor directly instead.

See libgit2's documentation on git_repository_init_ext for further details.
"""
# Pre-process input parameters
Expand Down
Loading