Add param annotation to method for clarity

Author: 11k

Diff for: lib/services/punishment-read-write-stream.js

@@ -93,6 +93,10 @@ class PunishmentReadWriteStream extends Transform {
     this.push(punished);
   }
 
+  /**
+   * @param {Object} punished
+   * @param {boolean} punished.isBannedWord `true` if this mute was automatically issued as a result of the user typing a banned word
+   */
   handleMute(punished) {
     getReporter().incrementCounter(METRIC_NAMES.MUTES_GIVEN, 1);
     let muteDuration = null;