From c34061a52e3752339adb5dc1473e6931fbf71895 Mon Sep 17 00:00:00 2001 From: Wliu <50Wliu@users.noreply.github.com> Date: Tue, 6 Jun 2017 23:33:29 -0400 Subject: [PATCH 1/4] :memo: Document the WorkspaceCenter class --- src/workspace-center.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/workspace-center.js b/src/workspace-center.js index 56d821265..80f305b46 100644 --- a/src/workspace-center.js +++ b/src/workspace-center.js @@ -3,6 +3,7 @@ const TextEditor = require('./text-editor') const PaneContainer = require('./pane-container') +// Essential: Represents the workspace at the center of the entire window. module.exports = class WorkspaceCenter { constructor (params) { params.location = 'center' From 55a0fcb3f2920ef3f9c5e30492cccdea47da88de Mon Sep 17 00:00:00 2001 From: Wliu <50Wliu@users.noreply.github.com> Date: Tue, 6 Jun 2017 23:33:46 -0400 Subject: [PATCH 2/4] :memo: Document pane location methods in Workspace --- src/workspace.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/workspace.js b/src/workspace.js index 53f7f5c62..6dcc9fcc7 100644 --- a/src/workspace.js +++ b/src/workspace.js @@ -1548,22 +1548,27 @@ module.exports = class Workspace extends Model { Section: Pane Locations */ + // Essential: Get the {WorkspaceCenter} at the center of the editor window. getCenter () { return this.paneContainers.center } + // Essential: Get the {Dock} to the left of the editor window. getLeftDock () { return this.paneContainers.left } + // Essential: Get the {Dock} to the right of the editor window. getRightDock () { return this.paneContainers.right } + // Essential: Get the {Dock} below the editor window. getBottomDock () { return this.paneContainers.bottom } + // Essential: Get an {Array} of the current {WorkspaceCenter} and {Dock}s. getPaneContainers () { return [ this.paneContainers.center, From 02258a9994030579af31b8e05f0e8a4f080da510 Mon Sep 17 00:00:00 2001 From: Wliu <50Wliu@users.noreply.github.com> Date: Tue, 6 Jun 2017 23:34:47 -0400 Subject: [PATCH 3/4] :memo: Fix get{Left|Right|Bottom}Dock links --- src/dock.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/dock.js b/src/dock.js index 0023c52e5..68a34464b 100644 --- a/src/dock.js +++ b/src/dock.js @@ -16,8 +16,8 @@ const CURSOR_OVERLAY_VISIBLE_CLASS = 'atom-dock-cursor-overlay-visible' // Extended: A container at the edges of the editor window capable of holding items. // You should not create a Dock directly. Instead, access one of the three docks of the workspace -// via {::getLeftDock}, {::getRightDock}, and {::getBottomDock} or add an item to a dock via -// {Workspace::open}. +// via {Workspace::getLeftDock}, {Workspace::getRightDock}, and {Workspace::getBottomDock} +// or add an item to a dock via {Workspace::open}. module.exports = class Dock { constructor (params) { this.handleResizeHandleDragStart = this.handleResizeHandleDragStart.bind(this) From 7c482913337e131c1b148edbc4beb30021cf78fa Mon Sep 17 00:00:00 2001 From: Wliu <50Wliu@users.noreply.github.com> Date: Wed, 7 Jun 2017 10:55:26 -0400 Subject: [PATCH 4/4] :fire: getPaneContainers from the API --- src/workspace.js | 1 - 1 file changed, 1 deletion(-) diff --git a/src/workspace.js b/src/workspace.js index 6dcc9fcc7..033b7c8c5 100644 --- a/src/workspace.js +++ b/src/workspace.js @@ -1568,7 +1568,6 @@ module.exports = class Workspace extends Model { return this.paneContainers.bottom } - // Essential: Get an {Array} of the current {WorkspaceCenter} and {Dock}s. getPaneContainers () { return [ this.paneContainers.center,