From f24590fb10f530fb4d068701ccca3cedc26e8112 Mon Sep 17 00:00:00 2001
From: Ivan Zuzak <izuzak@gmail.com>
Date: Tue, 4 Aug 2015 16:29:18 +0200
Subject: [PATCH] Clarify docs on Marker.copy to cover selection case

---
 src/marker.coffee | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/src/marker.coffee b/src/marker.coffee
index 536edfb63..636afdc12 100644
--- a/src/marker.coffee
+++ b/src/marker.coffee
@@ -67,10 +67,20 @@ class Marker
     @bufferMarker.destroy()
     @disposables.dispose()
 
-  # Essential: Creates and returns a new {Marker} with the same properties as this
-  # marker.
+  # Essential: Creates and returns a new {Marker} with the same properties as
+  # this marker.
   #
-  # * `properties` {Object}
+  # {Selection} markers (markers with a custom property `type: "selection"`)
+  # should be copied with a different `type` value, for example with
+  # `marker.copy({type: null})`. Otherwise, the new marker's selection will
+  # be merged with this marker's selection, and a `null` value will be
+  # returned.
+  #
+  # * `properties` (optional) {Object} properties to associate with the new
+  # marker. The new marker's properties are computed by extending this marker's
+  # properties with `properties`.
+  #
+  # Returns a {Marker}.
   copy: (properties) ->
     @displayBuffer.getMarker(@bufferMarker.copy(properties).id)