Add docstring for static var

matrix-org · Jun 27, 2019 · cab087b · cab087b
1 parent 9dd51cc
commit cab087b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/models/users/matrix.js b/lib/models/users/matrix.js
@@ -97,6 +97,10 @@ MatrixUser.prototype.escapeUserId = function() {
     this.userId = `@${this.localpart}:${this.host}`;
 };
 
+/**
+ * @static
+ * This is a global variable to modify the default escaping behaviour of MatrixUser.
+ */
 MatrixUser.ESCAPE_DEFAULT = true;