Add some Python docstrings

MycroftAI / mimic-recording-studio

Mimic Recording Studio is a Docker-based application you can install to record voice samples, which can then be trained into a TTS voice with Mimic2

Apache License 2.0

493 stars 111 forks source link

Add some Python docstrings #67

Closed thorstenMueller closed 2 years ago

thorstenMueller commented 2 years ago

Description

After chatting with @krisgesling i got to know Python docstrings. As being active in Mimic-Recording-Studio code i've added some docstrings.

Type of PR

[ ] Bugfix
[ ] Feature implementation
[ ] Refactor of code (without functional changes)
[X] Documentation improvements
[ ] Test improvements

Testing

An IDE (like VisualStudio Code) should show docs when hovering functions.

thorstenMueller commented 2 years ago

Hello @krisgesling . I've added some docstring comments, but feel free to adjust them with better englisch wording 😁 .

thorstenMueller commented 2 years ago

Hi @krisgesling . I've added docstrings for all remaining Python files. So (hopefully) documentation is now better than before. Feel free to improve my english phrases or (even better) directly merge the PR 😉 .

thorstenMueller commented 2 years ago

Hi @krisgesling . Any more feedback on that PR?