Skip to content

Commit b7c9e1f

Browse files
committed
Fix documentation of offset values
Text taken from review suggestions.
1 parent b505af6 commit b7c9e1f

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pygccxml/declarations/comment.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ def begin_line(self, begin_line):
6161

6262
@property
6363
def begin_offset(self):
64-
"""An integer value which corresponds to the
65-
line of the file where the comment begins
64+
"""An integer value representing the
65+
number of bytes from the beginning of the
66+
file to the start of the comment
6667
@type: int """
6768
return self._begin_offset
6869

@@ -94,8 +95,9 @@ def end_line(self, end_line):
9495

9596
@property
9697
def end_offset(self):
97-
"""An integer value which corresponds to the
98-
line of the file where the comment ends
98+
"""An integer value representing the
99+
number of bytes from the beginning of the
100+
file to the end of the comment
99101
@type: int """
100102
return self._end_offset
101103

0 commit comments

Comments
 (0)