aboutsummaryrefslogtreecommitdiff
path: root/lib/git/tag.py
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2009-10-08 18:17:05 +0200
committerSebastian Thiel <byronimo@gmail.com>2009-10-08 20:22:51 +0200
commit4251bd59fb8e11e40c40548cba38180a9536118c (patch)
treeb3cb0fad7a8792505e4da14ea5c5223d96f6aee9 /lib/git/tag.py
parent451561c252323e74696dbe0be36601c95a75a8c3 (diff)
downloadGitPython-4251bd59fb8e11e40c40548cba38180a9536118c.tar.gz
GitPython-4251bd59fb8e11e40c40548cba38180a9536118c.zip
Improved head and tag object documentation slightly
Diffstat (limited to 'lib/git/tag.py')
-rw-r--r--lib/git/tag.py25
1 files changed, 13 insertions, 12 deletions
diff --git a/lib/git/tag.py b/lib/git/tag.py
index f7bc140e..8413ce73 100644
--- a/lib/git/tag.py
+++ b/lib/git/tag.py
@@ -9,16 +9,13 @@ from commit import Commit
class Tag(object):
def __init__(self, name, commit):
"""
- Instantiate a new Tag
+ Initialize a newly instantiated Tag
``name``
is the name of the head
``commit``
is the Commit that the head points to
-
- Returns
- ``git.Tag``
"""
self.name = name
self.commit = commit
@@ -26,16 +23,19 @@ class Tag(object):
@classmethod
def find_all(cls, repo, **kwargs):
"""
- Find all Tags
+ Find all Tags in the repository
``repo``
is the Repo
``kwargs``
- is a dict of options
+ Additional options given as keyword arguments, will be passed
+ to git-for-each-ref
Returns
``git.Tag[]``
+
+ List is sorted by committerdate
"""
options = {'sort': "committerdate",
'format': "%(refname)%00%(objectname)"}
@@ -47,16 +47,16 @@ class Tag(object):
@classmethod
def list_from_string(cls, repo, text):
"""
- Parse out tag information into an array of baked Tag objects
+ Parse out tag information into an array of Tag objects
``repo``
is the Repo
``text``
- is the text output from the git command
+ is the text output from the git-for-each command
Returns
- ``git.Tag[]``
+ git.Tag[]
"""
tags = []
for line in text.splitlines():
@@ -74,13 +74,14 @@ class Tag(object):
``line``
is the formatted tag information
- Format
+ Format::
+
name: [a-zA-Z_/]+
<null byte>
id: [0-9A-Fa-f]{40}
-
+
Returns
- ``git.Tag``
+ git.Tag
"""
full_name, ids = line.split("\x00")
name = full_name.split("/")[-1]