orch ref docs fixes (WIP) #9768
Conversation
Deploying agoric-sdk with
|
| Latest commit: |
cb66f49
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://95ef2e48.agoric-sdk.pages.dev |
| Branch Preview URL: | https://dc-orch-ref-docs.agoric-sdk.pages.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #9768 +/- ##
=======================================
Coverage 56.38% 56.38%
=======================================
Files 667 667
Lines 207560 207575 +15
Branches 340 341 +1
=======================================
+ Hits 117024 117037 +13
- Misses 90417 90420 +3
+ Partials 119 118 -1
|
| @@ -23,6 +23,10 @@ import { | |||
|
|
|||
| const { Vow$ } = NetworkShape; // TODO #9611 | |||
| /** | |||
| * This is the greatest thing since sliced bread. | |||
| * | |||
| * TODO: private | |||
There was a problem hiding this comment.
https://typedoc.org/tags/private/ says it shouldn't be used. I think we want @internal
There was a problem hiding this comment.
I've struggled to get @internal to work. @mitdralla suggested @private, so I tried that. Also didn't work.
There was a problem hiding this comment.
For now I think we should assume we can get it working. Even when it's not omitted it has an INTERNAL tag which is better than nothing. #9808 (comment)
| @@ -3,11 +3,21 @@ import { VowShape } from '@agoric/vow'; | |||
| import { M } from '@endo/patterns'; | |||
|
|
|||
| /** | |||
| * @import {TypedPattern} from '@agoric/internal'; | |||
| * @import {TypedPattern as TPInternal} from '@agoric/internal'; | |||
There was a problem hiding this comment.
why rename this? If TypedPattern is to be internal (which I support) it should simply have the @internal tag. For that matter, I suppose everything in @agoric/internal should.
There was a problem hiding this comment.
The problem was: The docs showed DelegationShape: TypedPattern<Delegation> but TypedPattern wasn't linked, because it was from the internal package.
So this is an alias in the orchestration so that it gets linked. For example, see:
https://dc-orch-ref-docs.agoric-sdk.pages.dev/variables/_agoric_orchestration.DelegationShape
Moving TypedPattern to @endo/patterns might be a better way to fix this, but I'm not sure how to test that quickly.
There was a problem hiding this comment.
can we leave it unlinked? if Delegation is linked, that seems enough to me
There was a problem hiding this comment.
Delegation is also unlinked... it's from @agoric/cosmic-proto... I wonder if it's straightforward to address that.
There was a problem hiding this comment.
can we leave it (TypedPattern) unlinked?
I'm making a separate issue about it; we can decide to close it without action:
Added/Fixed a couple of lines in JSDocs comments for `prepareChainHubAdmin` with Dan's help.
goal of this DRAFT is:
closes: #9757
Description / Documentation Considerations
see commit headlines
Security / Scaling / Upgrade Considerations
n / a
Testing Considerations
manual review of @agoric/orchestration reference docs