Commit84e256d

committed

Describe Submodule.__init__ parent_commit parameter

This includes a brief description of the Submodule.__init__parent_commit parameter in its docstring, rather than onlyreferring to the set_parent_commit method, whose semantics differdue to conversation and validation, and which accepts more typesthan just Commit or None.The wording is based on wording in set_parent_commit, adjusted forthe difference in types, and set_parent_commit remains referencefor further details.This builds on1f03e7f (#1859) in improving the situation describedin#1869.

1 parentbcea9a8 commit84e256dCopy full SHA for 84e256d

File tree

1 file changed

-2

lines changed

git/objects/submodule
- base.py

1 file changed

-2

lines changed

`‎git/objects/submodule/base.py`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,9 @@ def __init__(`
`143`	`143`	See the `url` parameter.
`144`	`144`
`145`	`145`	`:param parent_commit:`
`146`		- See :meth:`set_parent_commit`.
	`146`	+ The :class:`~git.objects.commit.Commit` whose tree is supposed to contain
	`147`	+ the ``.gitmodules`` blob, or ``None`` to always point to the most recent
	`148`	+ commit. See :meth:`set_parent_commit` for details.
`147`	`149`
`148`	`150`	`:param url:`
`149`	`151`	`The URL to the remote repository which is the submodule.`
`@@ -1260,7 +1262,7 @@ def set_parent_commit(self, commit: Union[Commit_ish, str, None], check: bool =`
`1260`	`1262`	contain the ``.gitmodules`` blob.
`1261`	`1263`
`1262`	`1264`	`:param commit:`
`1263`		- Commit-ish reference pointing at theroot_tree, or ``None`` to always point
	`1265`	+ Commit-ish reference pointing at theroot tree, or ``None`` to always point
`1264`	`1266`	`to the most recent commit.`
`1265`	`1267`
`1266`	`1268`	`:param check:`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit84e256d

File tree

1 file changed

1 file changed

`‎git/objects/submodule/base.py`

0 commit comments