JavaScript icon indicating copy to clipboard operation
JavaScript copied to clipboard

Published 20 hours ago • verified publisher icon TheAlgorithms

[FEATURE]: Adding A workflow insuring including JSDOCS on every PR

Open mohmmadAyesh opened this issue 11 months ago • 3 comments

Motivation

Hi I thought it would be a nice idea to add a workflow that check if there is JSDOCS for every function when PR is opened do you want this feature in repo I will try to added if you accept

Examples

No response

Possible workarounds

No response

Additional information

No response

mohmmadAyesh avatar Mar 29 '24 08:03 mohmmadAyesh

Sounds useful. But there need not be a doc comment for every function, just for exported functions. It might very well be reasonable not to have doc comments for small internal helpers.

appgurueu avatar Mar 29 '24 13:03 appgurueu

well workflow it can be made only for exported functions but for small internal helpers dont know what criteria about how you can specify its a small helper file that doesnt need any JSDOCS

mohmmadAyesh avatar Mar 30 '24 07:03 mohmmadAyesh

well workflow it can be made only for exported functions

Yes. That's what I'm asking for. There should be no mandatory documentation for internal functions.

appgurueu avatar Mar 30 '24 13:03 appgurueu