Commit4251bd5

committed

Improved head and tag object documentation slightly

1 parent451561c commit4251bd5Copy full SHA for 4251bd5

File tree

3 files changed

+26

-24

lines changed

lib/git

3 files changed

+26

-24

lines changed

`‎lib/git/commit.py`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -136,8 +136,8 @@ def find_all(cls, repo, ref, path='', **kwargs):`
`136`	`136`	`is an optinal path, if set only Commits that include the path`
`137`	`137`	`will be considered`
`138`	`138`
`139`		- ``options``
`140`		`-is a Hash ofoptional arguments to git where`
	`139`	+ ``kwargs``
	`140`	`+ optional keyword arguments to git where`
`141`	`141`	``max_count`` is the maximum number of commits to fetch
`142`	`142`	``skip`` is the number of commits to skip
`143`	`143`

`‎lib/git/head.py`

Lines changed: 11 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -28,33 +28,33 @@ class Head(object):`
`28`	`28`
`29`	`29`	`def__init__(self,name,commit):`
`30`	`30`	`"""`
`31`		`-Instantiate anew Head`
	`31`	`+Initialize anewly instanced Head`
`32`	`32`
`33`	`33`	`name`
`34`	`34`	`is the name of the head`
`35`	`35`
`36`	`36`	`commit`
`37`		`- is the Commit that the head points to`
`38`		`-`
`39`		`- Returns`
`40`		`- git.Head`
	`37`	`+ is the Commit object that the head points to`
`41`	`38`	`"""`
`42`	`39`	`self.name=name`
`43`	`40`	`self.commit=commit`
`44`	`41`
`45`	`42`	`@classmethod`
`46`	`43`	`deffind_all(cls,repo,**kwargs):`
`47`	`44`	`"""`
`48`		`- Find all Heads`
	`45`	`+ Find all Heads in the repository`
`49`	`46`
`50`	`47`	`repo`
`51`	`48`	`is the Repo`
`52`	`49`
`53`	`50`	`kwargs`
`54`		`- is a dict of options`
	`51`	`+ Additional options given as keyword arguments, will be passed`
	`52`	`+ to git-for-each-ref`
`55`	`53`
`56`	`54`	`Returns`
`57`	`55`	`git.Head[]`
	`56`	`+`
	`57`	`+ List is sorted by committerdate`
`58`	`58`	`"""`
`59`	`59`
`60`	`60`	`options= {'sort':"committerdate",`
`@@ -67,12 +67,12 @@ def find_all(cls, repo, **kwargs):`
`67`	`67`	`@classmethod`
`68`	`68`	`deflist_from_string(cls,repo,text):`
`69`	`69`	`"""`
`70`		`- Parse out head information intoan array of baked head objects`
	`70`	`+ Parse out head information intoa list of head objects`
`71`	`71`
`72`	`72`	``repo``
`73`	`73`	`is the Repo`
`74`	`74`	``text``
`75`		`- is the text output from the git command`
	`75`	`+ is the text output from the git-for-each-ref command`
`76`	`76`
`77`	`77`	`Returns`
`78`	`78`	`git.Head[]`
`@@ -95,7 +95,8 @@ def from_string(cls, repo, line):`
`95`	`95`	``line``
`96`	`96`	`is the formatted head information`
`97`	`97`
`98`		`- Format`
	`98`	`+ Format::`
	`99`	`+`
`99`	`100`	`name: [a-zA-Z_/]+`
`100`	`101`	`<null byte>`
`101`	`102`	`id: [0-9A-Fa-f]{40}`

`‎lib/git/tag.py`

Lines changed: 13 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,33 +9,33 @@`
`9`	`9`	`classTag(object):`
`10`	`10`	`def__init__(self,name,commit):`
`11`	`11`	`"""`
`12`		`-Instantiate anew Tag`
	`12`	`+Initialize anewly instantiated Tag`
`13`	`13`
`14`	`14`	``name``
`15`	`15`	`is the name of the head`
`16`	`16`
`17`	`17`	``commit``
`18`	`18`	`is the Commit that the head points to`
`19`		`-`
`20`		`- Returns`
`21`		- ``git.Tag``
`22`	`19`	`"""`
`23`	`20`	`self.name=name`
`24`	`21`	`self.commit=commit`
`25`	`22`
`26`	`23`	`@classmethod`
`27`	`24`	`deffind_all(cls,repo,**kwargs):`
`28`	`25`	`"""`
`29`		`- Find all Tags`
	`26`	`+ Find all Tags in the repository`
`30`	`27`
`31`	`28`	``repo``
`32`	`29`	`is the Repo`
`33`	`30`
`34`	`31`	``kwargs``
`35`		`- is a dict of options`
	`32`	`+ Additional options given as keyword arguments, will be passed`
	`33`	`+ to git-for-each-ref`
`36`	`34`
`37`	`35`	`Returns`
`38`	`36`	``git.Tag[]``
	`37`	`+`
	`38`	`+ List is sorted by committerdate`
`39`	`39`	`"""`
`40`	`40`	`options= {'sort':"committerdate",`
`41`	`41`	`'format':"%(refname)%00%(objectname)"}`
`@@ -47,16 +47,16 @@ def find_all(cls, repo, **kwargs):`
`47`	`47`	`@classmethod`
`48`	`48`	`deflist_from_string(cls,repo,text):`
`49`	`49`	`"""`
`50`		`- Parse out tag information into an array ofbakedTag objects`
	`50`	`+ Parse out tag information into an array of Tag objects`
`51`	`51`
`52`	`52`	``repo``
`53`	`53`	`is the Repo`
`54`	`54`
`55`	`55`	``text``
`56`		`- is the text output from the git command`
	`56`	`+ is the text output from the git-for-each command`
`57`	`57`
`58`	`58`	`Returns`
`59`		-``git.Tag[]``
	`59`	`+ git.Tag[]`
`60`	`60`	`"""`
`61`	`61`	`tags= []`
`62`	`62`	`forlineintext.splitlines():`
`@@ -74,13 +74,14 @@ def from_string(cls, repo, line):`
`74`	`74`	``line``
`75`	`75`	`is the formatted tag information`
`76`	`76`
`77`		`- Format`
	`77`	`+ Format::`
	`78`	`+`
`78`	`79`	`name: [a-zA-Z_/]+`
`79`	`80`	`<null byte>`
`80`	`81`	`id: [0-9A-Fa-f]{40}`
`81`		`-`
	`82`	`+`
`82`	`83`	`Returns`
`83`		-``git.Tag``
	`84`	`+ git.Tag`
`84`	`85`	`"""`
`85`	`86`	`full_name,ids=line.split("\x00")`
`86`	`87`	`name=full_name.split("/")[-1]`

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!

Commit4251bd5

File tree

3 files changed

3 files changed

`‎lib/git/commit.py`

`‎lib/git/head.py`

`‎lib/git/tag.py`

0 commit comments