Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

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

Open
benjamincburns opened this issue Aug 10, 2022 · 1 comment
Open

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

benjamincburns opened this issue Aug 10, 2022 · 1 comment

Comments

@benjamincburns
Copy link
Contributor

benjamincburns commented Aug 10, 2022

When I run typedoc@0.22.18 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.
@haltman-at
Copy link
Contributor

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!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants