diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2009-10-08 23:50:51 +0200 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2009-10-08 23:50:51 +0200 |
| commit | b0e84a3401c84507dc017d6e4f57a9dfdb31de53 (patch) | |
| tree | 59ad57c3bb4460ed824a144ddc4f84e4b20675dc /lib/git/tag.py | |
| parent | 6da04adff0b96c5163b0c2530028b72be2fd26fd (diff) | |
| parent | 07eaa4ce2696a88ec0db6e91f191af1e48226aca (diff) | |
| download | GitPython-b0e84a3401c84507dc017d6e4f57a9dfdb31de53.tar.gz GitPython-b0e84a3401c84507dc017d6e4f57a9dfdb31de53.zip | |
Merge branch 'doc_enhancements' into fixes
Diffstat (limited to 'lib/git/tag.py')
| -rw-r--r-- | lib/git/tag.py | 25 |
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] |
