Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mohmmadAyesh opened this issue Mar 29, 2024 · 3 comments
Open

Comments

@mohmmadAyesh
Copy link

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

@appgurueu
Copy link
Collaborator

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.

@mohmmadAyesh
Copy link
Author

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

@appgurueu
Copy link
Collaborator

appgurueu commented Mar 30, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants