[doc] [py] improve source/sink descriptions
authorPaul Brossier <piem@piem.org>
Sun, 4 Nov 2018 12:42:13 +0000 (13:42 +0100)
committerPaul Brossier <piem@piem.org>
Sun, 4 Nov 2018 12:42:13 +0000 (13:42 +0100)
python/ext/py-sink.c
python/ext/py-source.c

index e57a329..f274776 100644 (file)
@@ -14,7 +14,7 @@ typedef struct
 static char Py_sink_doc[] = ""
 "sink(path, samplerate=44100, channels=1)\n"
 "\n"
-"Open `path` to write a WAV file.\n"
+"Write audio samples to file.\n"
 "\n"
 "Parameters\n"
 "----------\n"
index 6bdfd41..ca525bf 100644 (file)
@@ -18,7 +18,7 @@ typedef struct
 static char Py_source_doc[] = ""
 "source(path, samplerate=0, hop_size=512, channels=0)\n"
 "\n"
-"Create a new source, opening the given pathname for reading.\n"
+"Read audio samples from a media file.\n"
 "\n"
 "`source` open the file specified in `path` and creates a callable\n"
 "returning `hop_size` new audio samples at each invocation.\n"