Clarified documentation

This commit is contained in:
lightmare 2023-03-02 18:13:32 +00:00
parent d14f1b6c25
commit d6c4748424

View File

@ -156,7 +156,7 @@ cdef class Whisper:
filename: Path to file filename: Path to file
Returns: Returns:
A result id for extract_text(...) Return value of whisper_full for extract_text(...)
Raises: Raises:
RuntimeError: The given file could not be found RuntimeError: The given file could not be found
@ -172,13 +172,13 @@ cdef class Whisper:
"""Extracts the text from a transcription. """Extracts the text from a transcription.
Args: Args:
res: A result id from transcribe(...) res: A return value from transcribe(...)
Returns: Returns:
A list of transcribed strings. A list of transcribed strings.
Raises: Raises:
RuntimeError: The given result id was invalid. RuntimeError: The given return value was invalid.
""" """
#print("Extracting text...") #print("Extracting text...")
if res != 0: if res != 0:
@ -192,14 +192,14 @@ cdef class Whisper:
"""Extracts the text and timestamps from a transcription. """Extracts the text and timestamps from a transcription.
Args: Args:
res: A result id from transcribe(...) res: A return value from transcribe(...)
Returns: Returns:
A list of tuples containing start time, end time and transcribed text. A list of tuples containing start time, end time and transcribed text.
e.g. [(0, 500, " This is a test.")] e.g. [(0, 500, " This is a test.")]
Raises: Raises:
RuntimeError: The given result id was invalid. RuntimeError: The given return value was invalid.
""" """
if res != 0: if res != 0:
raise RuntimeError raise RuntimeError