From bd4f5ba544f6888afa95b44ff55db735dab8c954 Mon Sep 17 00:00:00 2001 From: Nathan Sobo Date: Fri, 28 Aug 2015 09:39:24 -0600 Subject: [PATCH] Replace Public with Essential MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Still not sure about the value of this distinction, but let’s blend in. --- src/text-editor.coffee | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/src/text-editor.coffee b/src/text-editor.coffee index e5cb0dabe..39da338f3 100644 --- a/src/text-editor.coffee +++ b/src/text-editor.coffee @@ -14,7 +14,7 @@ TextMateScopeSelector = require('first-mate').ScopeSelector {Directory} = require "pathwatcher" GutterContainer = require './gutter-container' -# Public: This class represents all essential editing state for a single +# Essential: This class represents all essential editing state for a single # {TextBuffer}, including cursor and selection positions, folds, and soft wraps. # If you're manipulating the state of an editor, use this class. If you're # interested in the visual appearance of editors, use {TextEditorView} instead. @@ -341,7 +341,7 @@ class TextEditor extends Model onDidInsertText: (callback) -> @emitter.on 'did-insert-text', callback - # Public: Invoke the given callback after the buffer is saved to disk. + # Essential: Invoke the given callback after the buffer is saved to disk. # # * `callback` {Function} to be called after the buffer is saved. # * `event` {Object} with the following keys: @@ -351,7 +351,7 @@ class TextEditor extends Model onDidSave: (callback) -> @getBuffer().onDidSave(callback) - # Public: Invoke the given callback when the editor is destroyed. + # Essential: Invoke the given callback when the editor is destroyed. # # * `callback` {Function} to be called when the editor is destroyed. # @@ -470,7 +470,7 @@ class TextEditor extends Model onDidUpdateMarkers: (callback) -> @displayBuffer.onDidUpdateMarkers(callback) - # Public: Retrieves the current {TextBuffer}. + # Essential: Retrieves the current {TextBuffer}. getBuffer: -> @buffer # Retrieves the current buffer's URI. @@ -616,7 +616,7 @@ class TextEditor extends Model # See {TextBuffer::save} for more details. save: -> @buffer.save(backup: atom.config.get('editor.backUpBeforeSaving')) - # Public: Saves the editor's text buffer as the given path. + # Essential: Saves the editor's text buffer as the given path. # # See {TextBuffer::saveAs} for more details. # @@ -729,7 +729,7 @@ class TextEditor extends Model # {Delegates to: TextBuffer.getEndPosition} getEofBufferPosition: -> @buffer.getEndPosition() - # Public: Get the {Range} of the paragraph surrounding the most recently added + # Essential: Get the {Range} of the paragraph surrounding the most recently added # cursor. # # Returns a {Range}. @@ -1328,7 +1328,7 @@ class TextEditor extends Model decorationParams.type = 'line-number' @displayBuffer.decorateMarker(marker, decorationParams) - # Public: Get all the decorations within a screen row range. + # Essential: Get all the decorations within a screen row range. # # * `startScreenRow` the {Number} beginning screen row # * `endScreenRow` the {Number} end screen row (inclusive) @@ -2308,7 +2308,7 @@ class TextEditor extends Model # * `replace` Call this {Function} with a {String} to replace the match. scan: (regex, iterator) -> @buffer.scan(regex, iterator) - # Public: Scan regular expression matches in a given range, calling the given + # Essential: Scan regular expression matches in a given range, calling the given # iterator function on each match. # # * `regex` A {RegExp} to search for. @@ -2322,7 +2322,7 @@ class TextEditor extends Model # * `replace` Call this {Function} with a {String} to replace the match. scanInBufferRange: (regex, range, iterator) -> @buffer.scanInRange(regex, range, iterator) - # Public: Scan regular expression matches in a given range in reverse order, + # Essential: Scan regular expression matches in a given range in reverse order, # calling the given iterator function on each match. # # * `regex` A {RegExp} to search for. @@ -2434,7 +2434,7 @@ class TextEditor extends Model # Returns a {Boolean}. toggleSoftWrapped: -> @setSoftWrapped(not @isSoftWrapped()) - # Public: Gets the column at which column will soft wrap + # Essential: Gets the column at which column will soft wrap getSoftWrapColumn: -> @displayBuffer.getSoftWrapColumn() ### @@ -2669,7 +2669,7 @@ class TextEditor extends Model @emit('did-insert-text', didInsertEvent) if includeDeprecatedAPIs @emitter.emit 'did-insert-text', didInsertEvent - # Public: For each selection, if the selection is empty, cut all characters + # Essential: For each selection, if the selection is empty, cut all characters # of the containing line following the cursor. Otherwise cut the selected # text. cutToEndOfLine: -> @@ -2821,7 +2821,7 @@ class TextEditor extends Model Section: Gutters ### - # Public: Creates and returns a {Gutter}. + # Essential: 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 @@ -2832,11 +2832,11 @@ class TextEditor extends Model addGutter: (options) -> @gutterContainer.addGutter(options) - # Public: Returns the {Array} of all gutters on this editor. + # Essential: Returns the {Array} of all gutters on this editor. getGutters: -> @gutterContainer.getGutters() - # Public: Returns the gutter with the given name, or null if it doesn't exist. + # Essential: Returns the gutter with the given name, or null if it doesn't exist. gutterWithName: (name) -> @gutterContainer.gutterWithName(name) @@ -2940,13 +2940,13 @@ class TextEditor extends Model Section: TextEditor Rendering ### - # Public: Retrieves the greyed out placeholder of a mini editor. + # Essential: Retrieves the greyed out placeholder of a mini editor. # # Returns a {String}. getPlaceholderText: -> @placeholderText - # Public: Set the greyed out placeholder of a mini editor. Placeholder text + # Essential: Set the greyed out placeholder of a mini editor. Placeholder text # will be displayed when the editor has no content. # # * `placeholderText` {String} text that is displayed when the editor has no content.