Ensure events have doc strings

learningequality · May 23, 2024 · 1e3f048 · 1e3f048
1 parent 81d1c5b
commit 1e3f048
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/lib/KImg/index.vue b/lib/KImg/index.vue
@@ -376,6 +376,9 @@
        */
       onError(event) {
         if (this.$listeners && this.$listeners.error) {
+          /**
+           * Emitted when the image fails to load or a misconfiguration error occurs. Expect either an `Event` or `Error`
+           */
           this.$emit('error', event);
         } else {
           // eslint-disable-next-line no-console

diff --git a/lib/tabs/tabsMixin.js b/lib/tabs/tabsMixin.js
@@ -129,6 +129,9 @@ export default {
       // Delegate error message to @error listener or `console.error` as fallback
       const e = new Error(`[${this.$options.name}] Missing 'ariaLabel' or 'ariaLabelledBy'`);
       if (this.$listeners && this.$listeners.error) {
+        /**
+         * Emitted with an error when a misconfiguration error occurs, if a listener is attached
+         */
         this.$emit('error', e);
       } else {
         // eslint-disable-next-line no-console