From: Paul Brossier Date: Sun, 4 Nov 2018 12:42:13 +0000 (+0100) Subject: [doc] [py] improve source/sink descriptions X-Git-Tag: 0.4.8~82 X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=a5c3f2aaddbaabc1a9025f7d2105d596a4c91439;p=aubio.git [doc] [py] improve source/sink descriptions --- diff --git a/python/ext/py-sink.c b/python/ext/py-sink.c index e57a3293..f2747761 100644 --- a/python/ext/py-sink.c +++ b/python/ext/py-sink.c @@ -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" diff --git a/python/ext/py-source.c b/python/ext/py-source.c index 6bdfd416..ca525bf4 100644 --- a/python/ext/py-source.c +++ b/python/ext/py-source.c @@ -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"