From fd8bc69eb9493ebbd7d68f3f84af9e297d757f36 Mon Sep 17 00:00:00 2001 From: Henrik Ingo Date: Mon, 23 Oct 2017 22:27:13 +0300 Subject: [PATCH] Add code comment that impress().swipe() is internal API method. By internal, we mean it is not documented on DOCUMENTATION.md. --- js/impress.js | 4 ++++ src/impress.js | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/js/impress.js b/js/impress.js index 08b0400..888b6e7 100644 --- a/js/impress.js +++ b/js/impress.js @@ -642,6 +642,10 @@ // transition to happen, this is just to animate the swipe. Once the // transition is committed - such as at a touchend event - caller is // responsible for also calling prev()/next() as appropriate. + // + // Note: For now, this function is made available to be used by the swipe plugin (which + // is the UI counterpart to this). It is a semi-internal API and intentionally not + // documented in DOCUMENTATION.md. var swipe = function( pct ) { if ( Math.abs( pct ) > 1 ) { return; diff --git a/src/impress.js b/src/impress.js index d8b243a..ad2134b 100644 --- a/src/impress.js +++ b/src/impress.js @@ -642,6 +642,10 @@ // transition to happen, this is just to animate the swipe. Once the // transition is committed - such as at a touchend event - caller is // responsible for also calling prev()/next() as appropriate. + // + // Note: For now, this function is made available to be used by the swipe plugin (which + // is the UI counterpart to this). It is a semi-internal API and intentionally not + // documented in DOCUMENTATION.md. var swipe = function( pct ) { if ( Math.abs( pct ) > 1 ) { return;