Add documentation for typescript via JSDoc #45
Conversation
There was a problem hiding this comment.
Various notes and questions, most of which are of exceedingly low importance.
Might want to check out the rendered version at https://github.com/WardBrian/tinystan/blob/start-js-docs/docs/languages/js.md to see how you like it; I think it could use more whitespace between sections, and/or more indentation--the various blocks describing the StanModel methods & their parameters, in particular, tend to run into each other--but I'm not sure whether you care or how easy that would be to fix with this tooling.
Overall though I think this is a good addition.
| * @property {number} [num_paths=4] The number of individual paths to run. | ||
| * @property {string | StanVariableInputs | string[] | StanVariableInputs[]} [inits=""] | ||
| * The initial values for the algorithm. If an array, must have length `num_paths`. | ||
| * @property {number | null} [seed] The seed for the random number generator. |
There was a problem hiding this comment.
Doesn't this default to null (or undefined?)
There was a problem hiding this comment.
It does, but the rendering for null is also pretty bad
https://brianward.dev/tinystan/latest/languages/js.html