Added basic comment descriptions to the scripts and to some of the source files. There's still much to be done, but it's a start.

This commit is contained in:
babetoduarte
2017-10-14 17:03:27 -05:00
parent 40460e0291
commit 1ff777d226
11 changed files with 29 additions and 0 deletions

View File

@@ -5,6 +5,10 @@ from amodem import common
from amodem.config import Configuration
import sys
"""Script that exposes pylab's spectogram plotting
capabilities to the command line. It implements this
for amodem.config Configurations.
"""
def spectrogram(t, x, Fs, NFFT=256):
ax1 = pylab.subplot(211)

View File

@@ -3,6 +3,9 @@ import argparse
from amodem import audio
from amodem.config import Configuration
"""Script that records audio through an interface
and stores it into an amodem.config Configuration.
"""
def run(args):
config = Configuration()

View File

@@ -3,6 +3,11 @@ from amodem.sampling import resample
import argparse
import sys
"""Script that exposes the amodem.resample() function
to the command line, taking parameters via standard
inputs and returning results via standard outputs.
"""
def main():
p = argparse.ArgumentParser()