Merge pull request #1094 from Tyriar/1089_open_parent_visible

Clarify that parent needs to be visible when calling open
2017-11-01 08:47:53 -07:00
parent aaa7e91855 664c0f0f77
commit d9e9fa3ff7
1 changed files with 3 additions and 1 deletions
@@ -290,7 +290,9 @@ declare module 'xterm' {
    /**
     * Opens the terminal within an element.
-     * @param parent The element to create the terminal within.
+     * @param parent The element to create the terminal within. This element
     * must be visible (have dimensions) when `open` is called as several DOM-
     * based measurements need to be performed when this function is called.
     */
    open(parent: HTMLElement): void;