search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 39 forks source link

Documentation of parameters is ugly and inconsistent #883

Open gibson042 opened 11 months ago

gibson042 commented 11 months ago

_Originally posted by @erights in https://github.com/Agoric/documentation/pull/876#discussion_r1410063904_

`farName` `{ String }`

What are these curly brackets about? If the intention is to mirror ts-in-jsdoc notation, the parameter name would come after the type, which I agree is unpleasant. How about we use ts notation for types in the docs:

`farName: string`
dckc commented 10 months ago

here's hoping to sync with typedoc, but @endo/marshal typedoc seems to be a stub so far.