Skip to content

Describe Submodule.__init__ parent_commit parameter #1877

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 15, 2024
Merged

Describe Submodule.__init__ parent_commit parameter #1877

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
Describe Submodule.__init__ parent_commit parameter 
This includes a brief description of the Submodule.__init__
parent_commit parameter in its docstring, rather than only
referring to the set_parent_commit method, whose semantics differ
due to conversation and validation, and which accepts more types
than just Commit or None.

The wording is based on wording in set_parent_commit, adjusted for
the difference in types, and set_parent_commit remains reference
for further details.

This builds on 1f03e7f (#1859) in improving the situation described
in #1869.
  • Loading branch information
@EliahKagan
EliahKagan committed Mar 14, 2024
commit 84e256d999f748f08bbd62bfa833f96664febcee
6 changes: 4 additions & 2 deletions git/objects/submodule/base.py
View file
Open in desktop
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