python/lib/aubio/cmd.py: improve tempo subcommand description
authorPaul Brossier <piem@piem.org>
Thu, 23 Mar 2017 14:32:21 +0000 (15:32 +0100)
committerPaul Brossier <piem@piem.org>
Thu, 23 Mar 2017 14:32:21 +0000 (15:32 +0100)
doc/aubio.txt
python/lib/aubio/cmd.py

index 2bcb8af..bee9eb1 100644 (file)
@@ -13,6 +13,7 @@ COMMANDS
   onset        get onset times
   pitch        extract fundamental frequency
   beat         get locations of beats
+  tempo        get overall tempo in bpm
   notes        get midi-like notes
   mfcc         extract mel-frequency cepstrum coefficients
   melbands     extract mel-frequency energies per band
@@ -88,6 +89,13 @@ BEAT
   The default buffer size for the beat algorithm is 1024. The default hop size
   is 512.
 
+TEMPO
+
+  The "tempo" command accepts all common options and no additional options.
+
+  The default buffer size for the beat algorithm is 1024. The default hop size
+  is 512.
+
 NOTES
 
   The "note" command accepts all common options and no additional options.
index 2ee823e..41d5489 100644 (file)
@@ -62,7 +62,7 @@ def aubio_parser():
 
     # tempo subcommand
     subparser = subparsers.add_parser('tempo',
-            help='get locations of beats')
+            help='get overal tempo in bpm')
     parser_add_input(subparser)
     parser_add_buf_hop_size(subparser, buf_size=1024, hop_size=512)
     parser_add_time_format(subparser)