Style for documenting C headers?

Open hoodmane opened this issue 5 years ago • 4 comments

The different C header files in src/typeconversions have inconsistent docstring comments. Do we have a style guide for these?

Dec 22 '20 21:12 hoodmane

Not as far as I know. Feel free to propose one, and add it to docs/contributing.md. Thanks!

Dec 22 '20 22:12 rth

I looked into this a bit and it looks like this could be a good option: https://hawkmoth.readthedocs.io/en/latest/ It would be good to add API docs for important private C / js apis to a different pyodide developers section.

Dec 29 '20 15:12 hoodmane

I looked into this a bit and it looks like this could be a good option: hawkmoth.readthedocs.io/en/latest

Sounds good.

Feb 12 '21 11:02 rth

@hoodmane do we still need this?

Sep 20 '25 07:09 ryanking13