search

elan-ev / vosk-cli

Apache License 2.0
2 stars 9 forks source link

Add docstrings to transcribe module #11

Closed owi92 closed 2 years ago

owi92 commented 2 years ago

This patch adds docstrings to each function in the transcribe module. I am a little unsure about a couple of things:

  1. Are these too detailled? not detailled enough?
  2. Is it common/good practice to reference other functions in a docstring?
  3. What would be the correct type of WebVTT?
  4. Pretty sure the summary line of the main function's docstring is redundant.