Added docs to arguments

docs/conf.py

@@ -2,6 +2,9 @@
 from __future__ import unicode_literals
 
 import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../src/'))
 
 
 extensions = [

src/scrrpy/cli.py

@@ -24,15 +24,18 @@
 @click.argument('name')
 @click.argument('sma', type=click.FLOAT)
 @click.argument('l_max', type=click.INT)
-@click.option('--gamma', default=1.75)
-@click.option('--mstar', default=1.0)
-@click.option('--mbh', default=4e6)
-@click.option('--rh', default=2.0)
-@click.option('--threads', default=1)
-@click.option('--neval', default=1e4)
-@click.option('--plot', is_flag=True)
-@click.option('--no_pbar', is_flag=True)
-@click.option('--j_grid', default=128)
+# @click.argument('sma', type=click.FLOAT, help='Semi-major axis [pc].')
+# @click.argument('l_max', type=click.INT, help='Maximum degree of spherical harmonics to compute')
+@click.option('--gamma', default=1.75, help="Slope of the cusp's density profile", show_default=True)
+@click.option('--mstar', default=1.0, help="Mass of individual stars [solar mass]", show_default=True)
+@click.option('--mbh', default=4.3e6, help="Massive black Hole mass [solar mass]", show_default=True)
+@click.option('--rh', default=2.0, help="Radius of influence [pc]", show_default=True)
+@click.option('--threads', default=1, help="Number of threads", show_default=True)
+@click.option('--neval', default=1e4, help="Maximum number of evaluation pass to the Vegas integrator", show_default=True)
+@click.option('--plot', is_flag=True, help="Plot the results into NAME.eps", show_default=True)
+@click.option('--no_pbar', is_flag=True, help="Suppress progress bar")
+@click.option('--j_grid', default=128, help="Size of the gird in j=J/J_c space. The grid is evenly spaced on log "
+                                            "scale between J_lc/J_c and 1", show_default=True)
 def main(name, sma, l_max, gamma, mstar, mbh, rh, threads, neval, plot,
          no_pbar, j_grid):
     drr = DRR(sma, gamma=gamma, mbh_mass=mbh, star_mass=mstar, rh=rh, j_grid_size=j_grid)