search

electron / fiddle-core

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

chore: add comments documenting public API #83

Open abhishekgite446 opened 1 year ago

abhishekgite446 commented 1 year ago

Addressing Issue 76

Adding comment using JSDoc for the function runFromCommandLine and replacing undocumented comments in etc/fiddle-core.api.md using yarn docs

abhishekgite446 commented 1 year ago

Hi @dsanders11, apologies that I had to close my previous commit due to a git issue. Opening this new PR to address Issue 76. I have only update the description for the function runFromCommandLine for now, can you please have a look ?

dsanders11 commented 1 year ago

It seems unnecessary to bump the version of @microsoft/api-extractor? The changes to etc/fiddle-core.api.md are also not included in these changes (which causes the workflow failure). Also, the comment shouldn't mention runFromCommandLine, and doesn't currently pass lint.

abhishekgite446 commented 1 year ago

Thanks for having a look @dsanders11. I guess pushed the changes in a rush. Thanks a lot for spotting everything, I have addressed all the issues you have raised previously. Can you please have a look when you get time :)

abhishekgite446 commented 1 year ago

Just so that you are aware, the only reason I bumped the version for @microsoft/api-extractor because I saw the following message when I executed yarn docs. Nevertheless the version bump was not required in the first place.

abhishekgite446 commented 1 year ago

@dsanders11 when you get time can you please have a look :)

abhishekgite446 commented 1 year ago

@dsanders11 as suggested made all changes. Please have a look at your convenience.

abhishekgite446 commented 1 year ago

@dsanders11 as suggested I have amended the comments, please have a look at your convenience 👍