search

seguid / seguid-javascript

SEGUID v2: Checksums for Linear, Circular, Single- and Double-Stranded Biological Sequences
https://www.seguid.org
MIT License
0 stars 1 forks source link

Document API using JSDoc #20

Open HenrikBengtsson opened 1 month ago

HenrikBengtsson commented 1 month ago

We should document the JavaScript SEGUID API, just like we do for R (https://seguid-r.seguid.org/) and Python (https://seguid-python.seguid.org/).

I don't know JavaScript well enough, but it looks like JSDoc is the de-facto standard for documenting a JavaScript package. @louisabraham, what do you think?

louisabraham commented 3 weeks ago

I think just having a webpage similar to what we have for Python and R would be good enough. For Python, I think you just used a rst comment (https://github.com/seguid/seguid-python/blob/main/src/seguid/__init__.py) instead of leveraging the function-level docstring abilities of Sphinx and I think that's ok.

I could do the same in markdown and we could put it on github pages. Does it look good to you?