github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-22 21:38:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix some doc strings

Browse Source
This commit is contained in:
Ben Ogle
2014-09-02 17:01:20 -07:00
parent 3d8f3883d1
commit ae0bffc4ea
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/editor.coffee
View File

@@ -1047,11 +1047,15 @@ class Editor extends Model
# Public: Convert a range in buffer-coordinates to screen-coordinates.
#
# * `bufferRange` {Range} in buffer coordinates to translate into screen coordinates.
#
# Returns a {Range}.
screenRangeForBufferRange: (bufferRange) -> @displayBuffer.screenRangeForBufferRange(bufferRange)
# Public: Convert a range in screen-coordinates to buffer-coordinates.
#
# * `screenRange` {Range} in screen coordinates to translate into buffer coordinates.
#
# Returns a {Range}.
bufferRangeForScreenRange: (screenRange) -> @displayBuffer.bufferRangeForScreenRange(screenRange)
@@ -1100,7 +1104,11 @@ class Editor extends Model
# editor.clipScreenPosition([2, Infinity]) # -> `[2, 10]`
# ```
#
# * `bufferPosition` The {Point} representing the position to clip.
# * `screenPosition` The {Point} representing the position to clip.
# * `options` (optional) {Object}
# * `wrapBeyondNewlines` {Boolean} if `true`, continues wrapping past newlines
# * `wrapAtSoftNewlines` {Boolean} if `true`, continues wrapping past soft newlines
# * `screenLine` {Boolean} if `true`, indicates that you're using a line number, not a row number
#
# Returns a {Point}.
clipScreenPosition: (screenPosition, options) -> @displayBuffer.clipScreenPosition(screenPosition, options)