search

ToposInstitute / CatColab

A collaborative environment for formal, interoperable, conceptual modeling
https://catcolab.org
MIT License
29 stars 7 forks source link

Typescript docs #53

Open olynch opened 3 months ago

olynch commented 3 months ago

We have great rust API docs, but the typescript docs are a little lacking: https://next.catcolab.org/dev/frontend/. Now that we actually build them, maybe we should have a policy like for the rust where docstrings are mandatory? And we should at least update the README!

epatters commented 3 months ago

That's fair. I've been pretty inconsistent about writing API docs for the frontend so far.

For Rust, we have the policy that every public export should have a doc-comment, which makes sense because catlog is a library, not an application. The frontend is an application, so what counts as "public" is less obvious to me. That said, requiring that everything with export have a doc-comment is stringent but should perhaps still be the standard.