summaryrefslogtreecommitdiff
path: root/lib/git/objects/submodule
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2010-11-21 17:48:03 +0100
committerSebastian Thiel <byronimo@gmail.com>2010-11-21 17:48:03 +0100
commit0b813371f5a8af95152cae109d28c7c97bfaf79f (patch)
tree766bcee6c13c0b443d4afc69e1c7e68a1ab7910a /lib/git/objects/submodule
parent9d6310db456de9952453361c860c3ae61b8674ea (diff)
downloadgitpython-0b813371f5a8af95152cae109d28c7c97bfaf79f.tar.gz
Fixed API reference docs as far as possible
Diffstat (limited to 'lib/git/objects/submodule')
-rw-r--r--lib/git/objects/submodule/base.py20
1 files changed, 12 insertions, 8 deletions
diff --git a/lib/git/objects/submodule/base.py b/lib/git/objects/submodule/base.py
index 7e0444f1..4f4223b6 100644
--- a/lib/git/objects/submodule/base.py
+++ b/lib/git/objects/submodule/base.py
@@ -722,9 +722,10 @@ class Submodule(util.IndexObject, Iterable, Traversable):
# END handle exception
def exists(self):
- """:return: True if the submodule exists, False otherwise. Please note that
- a submodule may exist (in the .gitmodules file) even though its module
- doesn't exist"""
+ """
+ :return: True if the submodule exists, False otherwise. Please note that
+ a submodule may exist (in the .gitmodules file) even though its module
+ doesn't exist"""
# keep attributes for later, and restore them if we have no valid data
# this way we do not actually alter the state of the object
loc = locals()
@@ -758,7 +759,8 @@ class Submodule(util.IndexObject, Iterable, Traversable):
@property
def branch_path(self):
- """:return: full (relative) path as string to the branch we would checkout
+ """
+ :return: full (relative) path as string to the branch we would checkout
from the remote and track"""
return self._branch_path
@@ -792,8 +794,9 @@ class Submodule(util.IndexObject, Iterable, Traversable):
return self._name
def config_reader(self):
- """:return: ConfigReader instance which allows you to qurey the configuration values
- of this submodule, as provided by the .gitmodules file
+ """
+ :return: ConfigReader instance which allows you to qurey the configuration values
+ of this submodule, as provided by the .gitmodules file
:note: The config reader will actually read the data directly from the repository
and thus does not need nor care about your working tree.
:note: Should be cached by the caller and only kept as long as needed
@@ -801,8 +804,9 @@ class Submodule(util.IndexObject, Iterable, Traversable):
return self._config_parser_constrained(read_only=True)
def children(self):
- """:return: IterableList(Submodule, ...) an iterable list of submodules instances
- which are children of this submodule
+ """
+ :return: IterableList(Submodule, ...) an iterable list of submodules instances
+ which are children of this submodule
:raise InvalidGitRepositoryError: if the submodule is not checked-out"""
return self._get_intermediate_items(self)