ansys / ansys/pre-commit-hooks

Enhance the tech_review hook

Open
#282 1 comment 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
5
Forks
1
Avg merge
4h 21m
Merged PRs (30d)
9

Description

### 📝 Description of the feature

Use the [docstring parser](https://pypi.org/project/docstring_parser/) to check docstrings in repositories are valid/compliant as suggested by @AlejandroFernandezLuces

Perhaps we can make this a new hook or add it to the tech_review hook

### 💡 Steps for implementing the feature

- Look through each python file in certain directories & parse the docstrings in each function and/or class

### 🔗 Useful links and references

[docstring parser](https://pypi.org/project/docstring_parser/)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.