Skip to content

Commit 974c721

Browse files
authored
Merge pull request #2511 from Tyriar/marker_doc
Clarify marker API docs
2 parents 1c72a66 + dac2da0 commit 974c721

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

typings/xterm.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,8 @@ declare module 'xterm' {
325325

326326
/**
327327
* Represents a specific line in the terminal that is tracked when scrollback
328-
* is trimmed and lines are added or removed.
328+
* is trimmed and lines are added or removed. This is a single line that may
329+
* be part of a larger wrapped line.
329330
*/
330331
export interface IMarker extends IDisposable {
331332
/**
@@ -339,7 +340,8 @@ declare module 'xterm' {
339340
readonly isDisposed: boolean;
340341

341342
/**
342-
* The actual line index in the buffer at this point in time.
343+
* The actual line index in the buffer at this point in time. This is set to
344+
* -1 if the marker has been disposed.
343345
*/
344346
readonly line: number;
345347
}

0 commit comments

Comments
 (0)