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;