updated help

Annie Hughes
1 parent b4cc1097
Showing 1 changed file with 50 additions and 4 deletions Show diff stats
src/idl/dstmwrp_exp.pro
 FUNCTION dstmwrp_exp, axis, index, number
  
-;IC: modified so that a '1' isn't displayed before the values
- 
+;+
+; NAME:
+;   dstmwrp_exp
+;  
+; PURPOSE:
+;   Returns formatted string for exponents in graphical output
+;  
+; CATEGORY:
+;    DustEMWrap, Distributed, LowLevel, Plotting
+;  
+; CALLING SEQUENCE:
+;    dstmwrp_exp, axis, index, number
+;
+; INPUTS:
+;    axis : deprecated but kept for backwards compatibility
+;    index : deprecated but kept for backwards compatibility
+;    number : value to be converted to exponential as formatted string  
+;
+; OPTIONAL INPUT PARAMETERS:
+;    None
+;
+; OUTPUTS:
+;    exponential as formatted string 
+;
+; OPTIONAL OUTPUT PARAMETERS:
+;
+; ACCEPTED KEY-WORDS:
+;
+; COMMON BLOCKS:
+;    None
+;
+; SIDE EFFECTS:
+;
+; RESTRICTIONS:
+;    The DustEMWrap IDL code must be installed
+;
+; PROCEDURES AND SUBROUTINES USED:
+;   
+; EXAMPLES
+;    expstr=dstmwrp_exp(axis, index, 15000.)
+;
+; MODIFICATION HISTORY:
+;    Written by IC
+;    Evolution details on the DustEMWrap gitlab.
+;    See http://dustemwrap.irap.omp.eu/ for FAQ and help.  
+;-
+   
   ;A special case.
   IF number EQ 0 THEN RETURN, '0'
  
@@ -32,5 +77,6 @@ FUNCTION dstmwrp_exp, axis, index, number
      IF first EQ 1 then RETURN, frmt + thisExponent + '!N' ELSE RETURN, first + 'x' + frmt + thisExponent + '!N'
   ENDELSE
  
- 
-END
 \ No newline at end of file
+the_end:
+  
+END