more typedoc #8720
Merged
more typedoc #8720
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dckc
approved these changes
Jan 8, 2024
| @@ -0,0 +1,3 @@ | |||
| # Vats | |||
|
|
|||
| Builders for Vats on the Agoric chain that aren't contracts. | |||
There was a problem hiding this comment.
there are some contracts here too; mintHolder and centralSupply come to mind.
But this will do for now.
| "src/offers.js", | ||
| "src/smartWallet.js", | ||
| "src/types.js", | ||
| "src/walletFactory.js", |
There was a problem hiding this comment.
walletFactory doesn't subsume the others as entry points?
(interesting that we don't have a "main" key in smart-wallet/package.json)
There was a problem hiding this comment.
Nope. I added these after getting warnings like,
[warning] InvitationSpec, defined in ./packages/smart-wallet/src/invitations.js, is referenced by offers.OfferSpec.__type.invitationSpec but not included in the documentation.
[warning] Petname, defined in ./packages/smart-wallet/src/types.d.ts, is referenced by smartWallet.BrandDescriptor.__type.petname but not included in the documentation.
[warning] MakeOfferWatcher, defined in ./packages/smart-wallet/src/offerWatcher.js, is referenced by smartWallet.ExecutorPowers.__type.makeOfferWatcher but not included in the documentation.
[warning] BrandDescriptor, defined in ./packages/smart-wallet/src/walletFactory.js, is referenced by walletFactory.makeAssetRegistry.makeAssetRegistry.__type.get.__type.__type but not included in the documentation.
6 tasks
turadg
force-pushed
the
ta/typedoc-vats
branch
from
0198d94 to
081714c
Compare
fixes, ``` [warning] Failed to convert type node with kind: JSDocAllType and text *. Please report a bug. ```
turadg
force-pushed
the
ta/typedoc-vats
branch
from
081714c to
b6f8b6d
Compare
This was referenced Jan 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Include several more packages in the TypeDoc build
Security Considerations
Scaling Considerations
Documentation Considerations
Testing Considerations
Upgrade Considerations