From fdc2bc49604280985bdf094905abab6421d59880 Mon Sep 17 00:00:00 2001 From: Megan Rogge Date: Tue, 15 Mar 2022 14:59:48 -0400 Subject: [PATCH] Update typings/xterm.d.ts Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com> --- typings/xterm.d.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index 05a1e786..b7c89319 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -475,10 +475,11 @@ declare module 'xterm' { height?: number; /** - * Renders the decoration in the scrollbar - * with the given @param color and optional @param position. - * If @param position is not set, it will span the full @param overviewRulerWidth, which - * must be provided via @TerminalOptions for this to work. + * When defined, renders the decoration in the overview ruler to the right + * of the terminal. {@link ITerminalOptions.overviewRulerWidth} must be set + * in order to see the overview ruler. + * @param color The color of the decoration. + * @param position The position of the decoration. */ overviewRulerOptions?: { color: string; position?: 'left' | 'center' | 'right'} }