From 65bb4baf0e479ff7cfbf0a8422824834c9f06ab1 Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Tue, 20 Jan 2015 01:33:38 +0000
Subject: doc: describe most classes a bit

Hopefully this makes the code less daunting to newcomers
---
 lib/dtas/partstats.rb | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'lib/dtas/partstats.rb')

diff --git a/lib/dtas/partstats.rb b/lib/dtas/partstats.rb
index b669d33..9d3312b 100644
--- a/lib/dtas/partstats.rb
+++ b/lib/dtas/partstats.rb
@@ -1,12 +1,13 @@
 # -*- encoding: binary -*-
 # Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
-# Unlike the stuff for dtas-player, dtas-partstats is fairly tied to sox
 require_relative '../dtas'
 require_relative 'xs'
 require_relative 'process'
 require_relative 'sigevent'
 
+# backend for the dtas-partstats(1) command
+# Unlike the stuff for dtas-player, dtas-partstats is fairly tied to sox
 class DTAS::PartStats
   CMD = 'sox "$INFILE" -n $TRIMFX $SOXFX stats $STATSOPTS'
   include DTAS::Process
-- 
cgit v1.2.3-24-ge0c7