truffle icon indicating copy to clipboard operation
truffle copied to clipboard

Typedoc missing on numerous types in @truffle/db-kit

Open benjamincburns opened this issue 3 years ago • 1 comments

When I run [email protected] in the @truffle/db-kit package, it gives me the following warnings.

Note that these are valid warnings, but to avoid dropping a pile of new warnings into the db-kit build, I've disabled these warnings in #5423. As a result, please be sure to remove the validation: { notExported: false } config from the typedoc config in packages/truffle/db-kit/typedoc.js on completion of this ticket.

Warning: TruffleConfig, defined at ../config/dist/index.d.ts:2, is referenced by Utils.FetchExternalOptions.config but not included in the documentation.
Warning: ConnectedProject, defined at ../db/dist/src/project/index.d.ts:154, is referenced by Utils.FetchExternalOptions.project but not included in the documentation.
Warning: Db, defined at ../db/dist/src/resources/types.d.ts:189, is referenced by Utils.QueryCompilationOptions.db but not included in the documentation.
Warning: ProjectInfo, defined at ../decoder/dist/index.d.ts:148, is referenced by Utils.prepareProjectInfo.prepareProjectInfo but not included in the documentation.
Warning: Resources.Resource, defined at ../db/dist/src/resources/types.d.ts:232, is referenced by Utils.queryCompilation.queryCompilation but not included in the documentation.

benjamincburns avatar Aug 10 '22 13:08 benjamincburns

Hm, since merging #6070, we no longer get these warnings. Of course that doesn't mean we don't want to address this even so!

haltman-at avatar Jun 05 '23 21:06 haltman-at