From 2772364dc1e42ad61c4672aeab82152093c83140 Mon Sep 17 00:00:00 2001
From: Stepan Kuzmin <stepankuzmin@yandex-team.ru>
Date: Mon, 9 Sep 2019 14:26:22 +0300
Subject: [PATCH] doc: add note that MapBoxZoomEvent originalEvent can be a
 click #8693

---
 src/ui/events.js | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/ui/events.js b/src/ui/events.js
index a6fe1fdb5b8..d548df807ae 100644
--- a/src/ui/events.js
+++ b/src/ui/events.js
@@ -214,6 +214,9 @@ export class MapWheelEvent extends Event {
 }
 
 /**
+ * A `MapBoxZoomEvent` is the event type for boxzoom-related map events.
+ * `originalEvent` can be a {@link Map.event:click} when the zoom is triggered by a UI event.
+ *
  * @typedef {Object} MapBoxZoomEvent
  * @property {MouseEvent} originalEvent
  */