From 450ee0c6a52ecf22dab31703f09a8ff7a28a36d1 Mon Sep 17 00:00:00 2001
From: meganrogge <merogge@microsoft.com>
Date: Wed, 16 Mar 2022 15:58:06 -0400
Subject: [PATCH] tweak  api

---
 typings/xterm.d.ts | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index 77f0b4ef..deaecb79 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -441,17 +441,20 @@ declare module 'xterm' {
 
     /**
      * The options for the overview ruler that can be updated.
-     * This will only take effect when
-     * @param overviewRulerOptions were provided initially.
+     * This will only take effect when {@link IDecorationOptions.overviewRulerOptions}
+     * were provided initially.
      */
      overviewRulerOptions?: Pick<IDecorationOverviewRulerOptions, 'color'>;
   }
 
 
-interface IDecorationOverviewRulerOptions {
-  color: string;
-  position?: 'left' | 'center' | 'right';
-}
+  /**
+   * Overview ruler decoration options
+   */
+  interface IDecorationOverviewRulerOptions {
+    color: string;
+    position?: 'left' | 'center' | 'right';
+  }
 
   /*
    * Options that define the presentation of the decoration.