search

Agoric / agoric-sdk

monorepo for the Agoric Javascript smart contract platform
Apache License 2.0
327 stars 206 forks source link

JSDocs comments for Orchestration Functions missing @returns #9801

Open amessbee opened 2 months ago

amessbee commented 2 months ago

What is the Problem Being Solved?

Several Orchestration API are missing @returns tag. This is needed for clarity and documentation.

Description of the Design

Add @returns tag.

Security/Scaling Considerations

None that I know of.

Test Plan

Manual Checking

Upgrade Considerations

None

dckc commented 2 months ago

Why is it needed? The tools infer it, no?

dckc commented 2 months ago

I wonder how this relates to #9765