Better docs, preserve funcitonality in case theme defines SHOW_STICKY…

…_NAV and uses largo_sticky_nav_active
WPBuddy · Apr 1, 2016 · 5b6199d · 5b6199d
1 parent 1a43720
commit 5b6199d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/functions.php b/functions.php
@@ -299,6 +299,7 @@ private function template_constants() {
 		/*
 		 * SHOW_STICKY_NAV is deprecated.
 		 * @link https://github.com/INN/Largo/issues/1135
+		 * @since 0.5.5
 		 */
 		if ( ! defined( 'SHOW_STICKY_NAV' ) ) {
 			define( 'SHOW_STICKY_NAV', FALSE );

diff --git a/inc/header-footer.php b/inc/header-footer.php
@@ -5,15 +5,16 @@
  *
  * Whether or not the sticky nav is displayed is determined by the javascript in js/navigation.js, since Largo 0.5.4.
  *
+ * @return Bool
  * @deprecated the constant SHOW_STICKY_NAV is deprecated
  * @link https://github.com/INN/Largo/issues/1135
- * @since 0.5.2
+ * @since 0.5.5
  */
 function largo_sticky_nav_active() {
-    if ( SHOW_STICKY_NAV ) {
-        return true;
-    }
-    return false;
+	if ( SHOW_STICKY_NAV ) {
+		return true;
+	}
+	return false;
 }
 
 /**