electron / fiddle-core

Run fiddles from anywhere, on any Electron release
MIT License
13 stars 16 forks source link

docs: Issue 76 Replacing undocumented comments with actual comments using JSDoc #82

Closed abhishekgite446 closed 1 year ago

abhishekgite446 commented 1 year ago
abhishekgite446 commented 1 year ago

@dsanders11 I have tried replacing the undocumented comments as suggested in Issue 76. Can you please confirm if you were expecting the same ? If yes then I would replace the other undocumented comments.

BTW this is my first contribution to any OpenSource so please bare with my stupid queries.

abhishekgite446 commented 1 year ago

Closing the PR due to an issue in my git.

dsanders11 commented 1 year ago

@abhishekgite446, these changes looked good, if you want to continue them after you resolve your git issues. 🙂

dsanders11 commented 1 year ago

Actually, sorry, took a closer look (d'oh). These descriptions should include changes to the src/ files, and then yarn docs will update etc/fiddle-core.api.md.