From 6cadd7c4a8580d71fa60ea0f1e6c896a6020a803 Mon Sep 17 00:00:00 2001
From: Daniel Imms <daimms@microsoft.com>
Date: Fri, 4 May 2018 10:02:01 -0700
Subject: [PATCH] Fill in documentation on new option

---
 src/renderer/dom/DomRenderer.ts |  2 --
 typings/xterm.d.ts              | 11 ++++++++++-
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/src/renderer/dom/DomRenderer.ts b/src/renderer/dom/DomRenderer.ts
index 79492689..cf0c7988 100644
--- a/src/renderer/dom/DomRenderer.ts
+++ b/src/renderer/dom/DomRenderer.ts
@@ -20,7 +20,6 @@ const BG_CLASS_PREFIX = 'xterm-bg-';
 const FOCUS_CLASS = 'xterm-focus';
 const SELECTION_CLASS = 'xterm-selection';
 
-// TODO: Document that links aren't supported in the DOM renderer
 // TODO: Pull into an addon when TS composite projects allow easier sharing of code (not just
 // interfaces) between core and addons
 export class DomRenderer extends EventEmitter implements IRenderer {
@@ -75,7 +74,6 @@ export class DomRenderer extends EventEmitter implements IRenderer {
     this.dimensions.scaledCharHeight = this._terminal.charMeasure.height * window.devicePixelRatio;
     this.dimensions.scaledCellWidth = this._terminal.charMeasure.width * window.devicePixelRatio;
     this.dimensions.scaledCellHeight = this._terminal.charMeasure.height * window.devicePixelRatio;
-    // TODO: Support line height and letter spacing
     this.dimensions.scaledCharLeft = 0;
     this.dimensions.scaledCharTop = 0;
     this.dimensions.scaledCanvasWidth = this.dimensions.scaledCellWidth * this._terminal.cols;
diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index 09217f13..2a63b9d5 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -102,7 +102,16 @@ declare module 'xterm' {
     macOptionIsMeta?: boolean;
 
     /**
-     * The type of renderer to use.
+     * (EXPERIMENTAL) The type of renderer to use, this allows using the
+     * fallback DOM renderer when canvas is too slow for the environment. The
+     * following features do not work when the DOM renderer is used:
+     *
+     * - Links
+     * - Line height
+     * - Letter spacing
+     *
+     * This option is marked as experiemental because it will eventually be
+     * moved to an addon.
      */
     rendererType?: RendererType;