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

Describe Submodule.__init__ parent_commit parameter #1877

Merged
merged 1 commit into from
Mar 15, 2024
Merged
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions git/objects/submodule/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,9 @@ def __init__(
See the `url` parameter.

:param parent_commit:
See :meth:`set_parent_commit`.
The :class:`~git.objects.commit.Commit` whose tree is supposed to contain
the ``.gitmodules`` blob, or ``None`` to always point to the most recent
commit. See :meth:`set_parent_commit` for details.

:param url:
The URL to the remote repository which is the submodule.
Expand Down Expand Up @@ -1260,7 +1262,7 @@ def set_parent_commit(self, commit: Union[Commit_ish, str, None], check: bool =
contain the ``.gitmodules`` blob.

:param commit:
Commit-ish reference pointing at the root_tree, or ``None`` to always point
Commit-ish reference pointing at the root tree, or ``None`` to always point
to the most recent commit.

:param check:
Expand Down
Loading