Merge pull request #144 from matrix-org/dbkr/set_visibility_doc

Clearer doc for setRoomDirectoryVisibility
matrix-org · Jun 22, 2016 · 7ff1cf4 · 7ff1cf4
2 parents 32f7ca5 + 1556cc4
commit 7ff1cf4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/client.js b/lib/client.js
@@ -2226,7 +2226,9 @@ MatrixClient.prototype.getRoomDirectoryVisibility =
 /**
  * Set the visbility of a room in the current HS's room directory
  * @param {string} roomId
- * @param {string} visibility
+ * @param {string} visibility "public" to make the room visible
+ *                 in the public directory, or "private" to make
+ *                 it invisible.
  * @param {module:client.callback} callback Optional.
  * @return {module:client.Promise} Resolves: result object
  * @return {module:http-api.MatrixError} Rejects: with an error response.