Open audrey01mit opened 4 months ago
Add a pre-commit hook to force documenting functions before committing a change. It should still be flexible for development though... Not obvious that a pre-commit hook would be the best way to do it, but it is still worth considering this issue.
see: sphinx doc coverage
You can always override precommit hooks if you really need to, so I'd vote for adding it. That way you can't forget to document your functions
Add a pre-commit hook to force documenting functions before committing a change. It should still be flexible for development though... Not obvious that a pre-commit hook would be the best way to do it, but it is still worth considering this issue.
see: sphinx doc coverage