From 999956d2270f0bc5f6b5336051da75fe0ac1ed0b Mon Sep 17 00:00:00 2001 From: Andreas Richter <708186+richtera@users.noreply.github.com> Date: Wed, 23 Aug 2023 08:09:19 -0400 Subject: [PATCH] fix: Userdoc property for errors were devdoc and userdoc was ignored. --- scripts/ci/docs-generate.ts | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/scripts/ci/docs-generate.ts b/scripts/ci/docs-generate.ts index ce32578a1..da9dafee3 100644 --- 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) =>