-
Notifications
You must be signed in to change notification settings - Fork 206
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
reference docs for network Port API #8852
Comments
I broke ground: 035eafb rendered: https://ag-api-docs-net.netlify.app/modules/_agoric_network.html |
for stuff that's not part of the developer API product: |
Generated docs for And in changes such as ae0e43e , we seem to be keeping them up-to-date. I suppose this bit is outdated; doesn't do much harm, though:
Ideally, the example code in the README would be tested, but meanwhile, tests for open / initiate / send / close are in $ yarn test test/test-network.js
...
✔ network - ibc
ℹ Opening a Listening Port
ℹ Accepting an Inbound Connection
ℹ Sending Data - echo
ℹ Receiving Data hello198
ℹ Closing the Connection
ℹ Connecting to a Remote Port
ℹ Sending Data - transfer
ℹ Receiving Data inbound-msg We punted these from the critical path:
|
What is the Problem Being Solved?
As a developer on the Agoric platform, I want to understand the network port API.
p.s. resolution: reference docs for @agoric/network package.
Description of the Design / Test Plan
As in the
@agoric/network
package README:See also unit tests:
use the typedoc approach (#8720) and refine the source code until the generated docs are adequate.
The usual PR review process seems sufficient to judge adequacy of reference docs.
punted these from the critical path:
Security / Scaling / Upgrade Considerations
n/a
background
In reviewing a recent PR aimed at adding the network-vat in an upcoming release (#8721), I learned that the network vat -- the Port API at least -- is part of the developer API product. So it needs reference docs.
cc @sufyaankhan @michaelfig @iomekam @turadg
The text was updated successfully, but these errors were encountered: