diff --git a/src/idl/dstmwrp_exp.pro b/src/idl/dstmwrp_exp.pro index 3e02c6d..e43a915 100644 --- a/src/idl/dstmwrp_exp.pro +++ b/src/idl/dstmwrp_exp.pro @@ -1,7 +1,52 @@ 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 -- libgit2 0.21.2