bessagroup / rvesimulator

Automated representative volume element simulator via abaqus for material constitutive law discovery
https://bessagroup.github.io/rvesimulator/
MIT License
14 stars 2 forks source link

Add docstrings to modules #48

Closed mpvanderschelling closed 10 months ago

mpvanderschelling commented 10 months ago

Problem

Your functions and classes have docstrings, but the python files itself (=modules) not. These can explain the need of that particular module

Possible solution

Add docstrings with a description of the modules to all .py files in your package