Inline documentation (and .gitignore)

.gitignore

@@ -4,6 +4,8 @@ MANIFEST
 doc/gh-pages/
 doc/html/
 doc/doctrees/
+doc/_build/
 gh-pages/
 build/
 dist/
+.vscode/

alsaaudio.c

@@ -914,6 +914,8 @@ alsapcm_setchannels(alsapcm_t *self, PyObject *args)
 PyDoc_STRVAR(setchannels_doc,
 "setchannels(numchannels)\n\
 \n\
+Deprecated since 0.9\n\
+\n\
 Used to set the number of capture or playback channels. Common values\n\
 are: 1 = mono, 2 = stereo, and 6 = full 6 channel audio.\n\
 \n\
@@ -955,6 +957,8 @@ alsapcm_setrate(alsapcm_t *self, PyObject *args)
 PyDoc_STRVAR(setrate_doc,
 "setrate(rate)\n\
 \n\
+Deprecated since 0.9\n\
+\n\
 Set the sample rate in Hz for the device. Typical values are\n\
 8000 (telephony), 11025, 44100 (CD), 48000 (DVD audio) and 96000");
 
@@ -992,7 +996,9 @@ alsapcm_setformat(alsapcm_t *self, PyObject *args)
 }
 
 PyDoc_STRVAR(setformat_doc,
-"setformat(rate)\n");
+"setformat(rate)\n\
+\n\
+Deprecated since 0.9");
 
 static PyObject *
 alsapcm_setperiodsize(alsapcm_t *self, PyObject *args)
@@ -1030,6 +1036,8 @@ alsapcm_setperiodsize(alsapcm_t *self, PyObject *args)
 PyDoc_STRVAR(setperiodsize_doc,
 "setperiodsize(period) -> int\n\
 \n\
+Deprecated since 0.9\n\
+\n\
 Sets the actual period size in frames. Each write should consist of\n\
 exactly this number of frames, and each read will return this number of\n\
 frames (unless the device is in PCM_NONBLOCK mode, in which case it\n\

doc/libalsaaudio.rst

@@ -116,7 +116,8 @@ following arguments:
      (default).  
    * *mode* - can be either :const:`PCM_NONBLOCK`, or :const:`PCM_NORMAL`
      (default). 
-   * *rate* - the sampling rate. The default value is 44100.
+   * *rate* - the sampling rate in Hz. Typical values are ``8000``
+    (mainly used for telephony), ``16000``, ``44100`` (default), ``48000`` and ``96000``.
    * *channels* - the number of channels. The default value is 2 (stereo).
    * *format* - the data format. This controls how the PCM device interprets data for playback, and how data is encoded in captures. 
      The default value is :const:`PCM_FORMAT_S16_LE`.