[Dart-dev] [5797] DART/branches/development/matlab/rank_hist.m: Better help file for a function that probably should not be 'visible'.

[nancy at ucar.edu]

Revision: 5797
Author:   thoar
Date:     2012-07-18 09:17:31 -0600 (Wed, 18 Jul 2012)
Log Message:
-----------
Better help file for a function that probably should not be 'visible'.
The help file steers the person to plot_bins.m

Modified Paths:
--------------
    DART/branches/development/matlab/rank_hist.m

-------------- next part --------------
Modified: DART/branches/development/matlab/rank_hist.m
===================================================================
--- DART/branches/development/matlab/rank_hist.m	2012-07-17 22:58:54 UTC (rev 5796)
+++ DART/branches/development/matlab/rank_hist.m	2012-07-18 15:17:31 UTC (rev 5797)
@@ -1,6 +1,15 @@
 function bins = rank_hist(ens, verif)
-%% RANK_HIST: Computes a rank histogram given time series of ensemble and verification 
+%% RANK_HIST: private function to compute a rank histogram given time series of ensemble and verification
+%
+% The function to create and plot the rank histogram is called "plot_bins".
+%
+% Example
+%
+% truth_file = 'True_State.nc';
+% diagn_file = 'Prior_Diag.nc';
+% plot_bins
 
+
 %% DART software - Copyright 2004 - 2011 UCAR. This open source software is
 % provided by UCAR, "as is", without charge, subject to all terms of use at
 % http://www.image.ucar.edu/DAReS/DART/DART_download