8000 docs: fix doc strings · video-db/videodb-python@6ee30af · GitHub
[go: up one dir, main page]

Skip to content

Commit 6ee30af

Browse files
committed
docs: fix doc strings
1 parent 1c5a8e2 commit 6ee30af

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

videodb/collection.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,11 @@ def generate_voice(
248248
config: dict = {},
249249
callback_url: Optional[str] = None,
250250
) -> Audio:
251-
"""Generate text to speech audio.
251+
"""Generate voice from text.
252252
253-
:param str text: Text to convert to speech
254-
:param dict config: Configuration for the text to speech generation
253+
:param str text: Text to convert to voice
254+
:param str voice_name: Name of the voice to use
255+
:param dict config: Configuration for the voice generation
255256
:param str callback_url: URL to receive the callback (optional)
256257
:return: :class:`Audio <Audio>` object
257258
:rtype: :class:`videodb.audio.Audio`
@@ -272,6 +273,14 @@ def generate_voice(
272273
def dub_video(
273274
self, video_id: str, language_code: str, callback_url: Optional[str] = None
274275
) -> Video:
276+
"""Dub a video.
277+
278+
:param str video_id: ID of the video to dub
279+
:param str language_code: Language code to dub the video to
280+
:param str callback_url: URL to receive the callback (optional)
281+
:return: :class:`Video <Video>` object
282+
:rtype: :class:`videodb.video.Video`
283+
"""
275284
dub_data = self._connection.post(
276285
path=f"{ApiPath.collection}/{self.id}/{ApiPath.generate}/{ApiPath.video}/{ApiPath.dub}",
277286
data={

videodb/video.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,12 +255,12 @@ def translate_transcript(
255255
additional_notes: str = "",
256256
callback_url: Optional[str] = None,
257257
) -> List[dict]:
258-
"""Translate transcript of a video to a language.
258+
"""Translate transcript of a video to a given language.
259259
260-
:param str language: Language to translate the subtitles to
260+
:param str language: Language to translate the transcript
261261
:param str additional_notes: Additional notes for the style of language
262262
:param str callback_url: URL to receive the callback (optional)
263-
:return: List of translated subtitles
263+
:return: List of translated transcript
264264
:rtype: List[dict]
265265
"""
266266
translate_data = self._connection.post(

0 commit comments

Comments
 (0)
0