Commit2376bd3

committed

Clarify costs of certain properties

1 parent4bcc4d5 commit2376bd3Copy full SHA for 2376bd3

File tree

-2

lines changed

-2

lines changed

Lines changed: 7 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -254,7 +254,9 @@ def references(self):`
`254`	`254`
`255`	`255`	`@property`
`256`	`256`	`defindex(self):`
`257`		`-""":return: IndexFile representing this repository's index."""`
	`257`	`+""":return: IndexFile representing this repository's index.`
	`258`	+ :note: This property can be expensive, as the returned ``IndexFile`` will be
	`259`	`+ reinitialized. It's recommended to re-use the object."""`
`258`	`260`	`returnIndexFile(self)`
`259`	`261`
`260`	`262`	`@property`
`@@ -624,7 +626,10 @@ def untracked_files(self):`
`624`	`626`	`are relative to the current working directory of the git command.`
`625`	`627`
`626`	`628`	`:note:`
`627`		`- ignored files will not appear here, i.e. files mentioned in .gitignore"""`
	`629`	`+ ignored files will not appear here, i.e. files mentioned in .gitignore`
	`630`	`+ :note:`
	`631`	`+ This property is expensive, as no cache is involved. To process the result, please`
	`632`	`+ consider caching it yourself."""`
`628`	`633`	`returnself._get_untracked_files()`
`629`	`634`
`630`	`635`	`def_get_untracked_files(self,**kwargs):`

Comments

(0)