Showing the changes to python/ext (1 of 1 file). Show all
Unified · Split
| @@ -58,7 +58,22 @@ static char Py_aubio_unary_types[] = { · 57 unmodified lines | ||
| 58 | 58 | //NPY_OBJECT, NPY_OBJECT, |
| 59 | 59 | }; |
| 60 | 60 | |
| 61 | −static char Py_unwrap2pi_doc[] = "map angle to unit circle [-pi, pi["; | |
| 61 | +// Note: these docstrings should *not* include the function signatures | |
| 62 | + | |
| 63 | +static char Py_unwrap2pi_doc[] = "" | |
| 64 | +"\n" | |
| 65 | +"Map angle to unit circle :math:`[-\\pi, \\pi[`.\n" | |
| 66 | +"\n" | |
| 67 | +"Parameters\n" | |
| 68 | +"----------\n" | |
| 69 | +"x : numpy.ndarray\n" | |
| 70 | +" input array\n" | |
| 71 | +"\n" | |
| 72 | +"Returns\n" | |
| 73 | +"-------\n" | |
| 74 | +"numpy.ndarray\n" | |
| 75 | +" values clamped to the unit circle :math:`[-\\pi, \\pi[`\n" | |
| 76 | +""; | |
| 62 | 77 | |
| 63 | 78 | static void* Py_unwrap2pi_data[] = { |
| 64 | 79 | (void *)aubio_unwrap2pi, |
| @@ -67,14 +82,40 @@ static void* Py_unwrap2pi_data[] = { · 2 unmodified lines | ||
| 67 | 82 | //(void *)unwrap2pio, |
| 68 | 83 | }; |
| 69 | 84 | |
| 70 | −static char Py_freqtomidi_doc[] = "convert frequency to midi"; | |
| 85 | +static char Py_freqtomidi_doc[] = "" | |
| 86 | +"\n" | |
| 87 | +"Convert frequency `[0; 23000[` to midi `[0; 128[`.\n" | |
| 88 | +"\n" | |
| 89 | +"Parameters\n" | |
| 90 | +"----------\n" | |
| 91 | +"x : numpy.ndarray\n" | |
| 92 | +" Array of frequencies, in Hz.\n" | |
| 93 | +"\n" | |
| 94 | +"Returns\n" | |
| 95 | +"-------\n" | |
| 96 | +"numpy.ndarray\n" | |
| 97 | +" Converted frequencies, in midi note.\n" | |
| 98 | +""; | |
| 71 | 99 | |
| 72 | 100 | static void* Py_freqtomidi_data[] = { |
| 73 | 101 | (void *)aubio_freqtomidi, |
| 74 | 102 | (void *)aubio_freqtomidi, |
| 75 | 103 | }; |
| 76 | 104 | |
| 77 | −static char Py_miditofreq_doc[] = "convert midi to frequency"; | |
| 105 | +static char Py_miditofreq_doc[] = "" | |
| 106 | +"\n" | |
| 107 | +"Convert midi `[0; 128[` to frequency `[0, 23000]`.\n" | |
| 108 | +"\n" | |
| 109 | +"Parameters\n" | |
| 110 | +"----------\n" | |
| 111 | +"x : numpy.ndarray\n" | |
| 112 | +" Array of frequencies, in midi note.\n" | |
| 113 | +"\n" | |
| 114 | +"Returns\n" | |
| 115 | +"-------\n" | |
| 116 | +"numpy.ndarray\n" | |
| 117 | +" Converted frequencies, in Hz\n" | |
| 118 | +""; | |
| 78 | 119 | |
| 79 | 120 | static void* Py_miditofreq_data[] = { |
| 80 | 121 | (void *)aubio_miditofreq, |