Skip to content

Commit 1ac48dc

Browse files
author
Alexandre Salomé
committed
add a paragraph about the blame line object
1 parent a7c06d7 commit 1ac48dc

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/api/blame.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,19 @@ If you want to access directly a line:
2525
2626
$line = $blame->getLine(32);
2727
28+
The Line object
29+
---------------
30+
31+
LineObject represents an item of the blame file. It is composed of those informations:
32+
33+
.. code-block:: php
34+
35+
$line->getCommit(); // returns a Commit
36+
$line->getContent(); // returns text
37+
38+
// you can access author from commmit:
39+
$author = $line->getCommit()->getAuthorName();
40+
2841
Group reading by commit
2942
-----------------------
3043

0 commit comments

Comments
 (0)