Add documentation notes

robotpy · Jan 17, 2016 · 882faf0 · 882faf0
1 parent 7985653
commit 882faf0
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/docs/api_js.rst b/docs/api_js.rst
@@ -93,11 +93,17 @@ NetworkTables Interface
 
     :param key: A networktables key
     :returns: true if a key is present in NetworkTables, false otherwise
+
+    .. warning:: This may not return correct results when the websocket is not
+                 connected
 
 .. js:function:: NetworkTables.getKeys()
 
     :returns: all the keys in the NetworkTables
 
+    .. warning:: This may not return correct results when the websocket is not
+                 connected
+
 .. js:function:: NetworkTables.getValue(key[, defaultValue])
 
     Returns the value that the key maps to. If the websocket is not
@@ -107,6 +113,9 @@ NetworkTables Interface
     :param defaultValue: If the key isn't present in the table, return this instead
     :returns: value of key if present, ``undefined`` or ``defaultValue`` otherwise
 
+    .. warning:: This may not return correct results when the websocket is not
+                 connected
+
     .. note:: To make a fully dynamic webpage that updates when the robot
               updates values, it is recommended (and simpler) to use
               :func:`addKeyListener` or :func:`addGlobalListener` to listen

diff --git a/pynetworktables2js/js/networktables.js b/pynetworktables2js/js/networktables.js
@@ -182,12 +182,22 @@ var NetworkTables = new function () {
 		}
 	};
 
-	// Returns true/false if key is in NetworkTables
+	/**
+		Returns true/false if key is in NetworkTables
+
+		.. warning:: This may not return correct results when the websocket is not
+                 	 connected
+    */
 	this.containsKey = function(key) {
 		return ntCache.has(key);
 	};
 
-	// Returns all the keys in the NetworkTables
+	/**
+		Returns all the keys in the NetworkTables
+		
+		.. warning:: This may not return correct results when the websocket is not
+                 	 connected
+    */
 	this.getKeys = function() {
 		return ntCache.getKeys();
 	};
@@ -200,6 +210,9 @@ var NetworkTables = new function () {
 	    :param defaultValue: If the key isn't present in the table, return this instead
 	    :returns: value of key if present, ``undefined`` or ``defaultValue`` otherwise
 
+	    .. warning:: This may not return correct results when the websocket is not
+                 	 connected
+
 	    .. note:: To make a fully dynamic webpage that updates when the robot
 	              updates values, it is recommended (and simpler) to use
 	              :func:`addKeyListener` or :func:`addGlobalListener` to listen