docs: updated explanation of the `rev` parameter for both blame methods · gitpython-developers/GitPython@27d8a14 · GitHub

1. gitpython-developers
2. GitPython

Repository navigation

• Code
• Issues6 (6)
• Pull requests2 (2)
• Discussions
• Actions
• Security and quality42 (42)
• Insights

Commit 27d8a14

Browse filesBrowse the repository at this point in the historyBrowse files

Gaubbe

committed

docs: updated explanation of the rev parameter for both blame methods

1 parent bbabcdc commit 27d8a14
Copy full SHA for 27d8a14

1 file changed

+6-2Lines changed: 6 additions & 2 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• git/repo
  • base.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎git/repo/base.py‎

Copy file name to clipboardExpand all lines: git/repo/base.py

+6-2Lines changed: 6 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -963,7 +963,9 @@ def blame_incremental(self, rev: str | HEAD | None, file: str, **kwargs: Any) ->
963	963	Unlike :meth:`blame`, this does not return the actual file's contents, only a
964	964	stream of :class:`BlameEntry` tuples.
965	965
966		- :param rev: Revision specifier, see git-rev-parse for viable options.
	966	+ :param rev: Revision specifier. If `None`, the blame will include all the latest
	967	+ uncommitted changes. Otherwise, anything succesfully parsed by git-rev-parse
	968	+ is a valid option.
967	969
968	970	:return: Lazy iterator of :class:`BlameEntry` tuples, where the commit indicates
969	971	the commit to blame for the line, and range indicates a span of line numbers
@@ -1053,7 +1055,9 @@ def blame(
1053	1055	) -> List[List[Commit | List[str | bytes] | None]] | Iterator[BlameEntry] | None:
1054	1056	"""The blame information for the given file at the given revision.
1055	1057
1056		- :param rev: Revision specifier, see git-rev-parse for viable options.
	1058	+ :param rev: Revision specifier. If `None`, the blame will include all the latest
	1059	+ uncommitted changes. Otherwise, anything succesfully parsed by git-rev-parse
	1060	+ is a valid option.
1057	1061
1058	1062	:return:
1059	1063	list: [git.Commit, list: [<line>]]

0 commit comments

Comments

0 (0)