From fac979f71d2cd2396ffb8d1246d70d466f074909 Mon Sep 17 00:00:00 2001 From: Maxim Sokolov Date: Wed, 26 Aug 2015 11:16:23 +0300 Subject: [PATCH] :memo: Update docs for TextEditor::addGutter TextEditor::addGutter should be called directly. --- src/gutter-container.coffee | 8 -------- src/text-editor.coffee | 8 +++++++- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/src/gutter-container.coffee b/src/gutter-container.coffee index 4fa7c61fb..bc8ce4246 100644 --- a/src/gutter-container.coffee +++ b/src/gutter-container.coffee @@ -21,14 +21,6 @@ class GutterContainer @gutters = [] @emitter.dispose() - # Creates and returns a {Gutter}. - # * `options` An {Object} with the following fields: - # * `name` (required) A unique {String} to identify this gutter. - # * `priority` (optional) A {Number} that determines stacking order between - # gutters. Lower priority items are forced closer to the edges of the - # window. (default: -100) - # * `visible` (optional) {Boolean} specifying whether the gutter is visible - # initially after being created. (default: true) addGutter: (options) -> options = options ? {} gutterName = options.name diff --git a/src/text-editor.coffee b/src/text-editor.coffee index 5f6408c30..2a69e8a10 100644 --- a/src/text-editor.coffee +++ b/src/text-editor.coffee @@ -515,7 +515,13 @@ class TextEditor extends Model @emitter.on 'did-change-line-number-gutter-visible', callback # Public: Creates and returns a {Gutter}. - # See {GutterContainer::addGutter} for more details. + # * `options` An {Object} with the following fields: + # * `name` (required) A unique {String} to identify this gutter. + # * `priority` (optional) A {Number} that determines stacking order between + # gutters. Lower priority items are forced closer to the edges of the + # window. (default: -100) + # * `visible` (optional) {Boolean} specifying whether the gutter is visible + # initially after being created. (default: true) addGutter: (options) -> @gutterContainer.addGutter(options)