Merge pull request #686 from lukso-network/fix/userdocs-errors

fix: userdoc/devdoc for errors.
lukso-network · Aug 23, 2023 · bd48b70 · bd48b70
2 parents e938d86 + 84b1df9
commit bd48b70
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/scripts/ci/docs-generate.ts b/scripts/ci/docs-generate.ts
@@ -153,7 +153,7 @@ task('ts-gen', 'Generate NatSpec documentation automatically on compilation')
           methods: object;
           errors: object;
         };
-        userdoc?: { events: object; methods: object };
+        userdoc?: { events: object; methods: object; errors: object };
       };
 
       const fileName = `${name}.json`;
@@ -203,14 +203,14 @@ task('ts-gen', 'Generate NatSpec documentation automatically on compilation')
         }
         for (const [sig, error] of Object.entries(errors)) {
           if (error.length) {
-            allMembers[sig].userdoc = error;
+            allMembers[sig].devdoc = error;
           }
         }
       }
       {
         // Handle userdoc
 
-        const { events = {}, methods = {} } = userdoc;
+        const { events = {}, methods = {}, errors = {} } = userdoc;
         for (const [sig, event] of Object.entries(events)) {
           if (Object.keys(event).length) {
             allMembers[sig].userdoc = event;
@@ -221,6 +221,11 @@ task('ts-gen', 'Generate NatSpec documentation automatically on compilation')
             allMembers[sig].userdoc = method;
           }
         }
+        for (const [sig, error] of Object.entries(errors)) {
+          if (error.length) {
+            allMembers[sig].userdoc = error;
+          }
+        }
       }
 
       const constructorName: string | undefined = Object.keys(allMembers).find((k) =>