Added Docstrings for the classes and functions #58
Conversation
deepgram/transcription.py
Outdated
| """ | ||
| This function initializes the options and transcription_options for the PrerecordedTranscription class. | ||
|
|
||
| :param self: Used to Refer to the object itself. |
There was a problem hiding this comment.
Can we remove this line: :param self: Used to Refer to the object itself. from the docstring. Otherwise, really great job on this task!
deepgram/transcription.py
Outdated
|
|
||
| prerecorded_transcription = PrerecordedTranscription(...) | ||
|
|
||
| :param self: Used to Access the class attributes. |
There was a problem hiding this comment.
Please remove this line from the docstring :param self: Used to Access the class attributes.
deepgram/transcription.py
Outdated
| accessed using "self." notation. In this case, it sets up a list to store any | ||
| messages received from Transcribe Streaming. | ||
|
|
||
| :param self: Used to Reference the object instance of the class. |
There was a problem hiding this comment.
Please remove this line from docstring :param self: Used to Reference the object instance of the class.
deepgram/transcription.py
Outdated
| transcription process. It returns itself after starting so that operations can | ||
| be chained. | ||
|
|
||
| :param self: Used to Access the attributes of the class. |
There was a problem hiding this comment.
Please remove this line from docstring :param self: Used to Access the attributes of the class.
deepgram/transcription.py
Outdated
| _start function will run until it receives a message with an empty transcription, | ||
| at which point it will close the socket and return. | ||
|
|
||
| :param self: Used to Access the class attributes. |
There was a problem hiding this comment.
Please remove this line from docstring :param self: Used to Access the class attributes.
deepgram/transcription.py
Outdated
| It is started by calling start_receiver() on an instance of AsyncSocket. It runs until the socket is closed, | ||
| or until an exception occurs. | ||
|
|
||
| :param self: Used to Access the attributes of the class. |
There was a problem hiding this comment.
Please remove this line from docstring :param self: Used to Access the attributes of the class.
deepgram/transcription.py
Outdated
| transcription service sends a ping event. It calls all of the functions | ||
| in self.handlers, which are registered by calling add_ping_handler(). | ||
|
|
||
| :param self: Used to Access the attributes and methods of the class. |
There was a problem hiding this comment.
Please remove this line from docstring :param self: Used to Access the attributes and methods of the class.
@geekchick Please review it and share your feedback.
#55