Add example usage section

6773088b · Pierre Cazenave · 0109e328 · 6773088b
Commit 6773088b authored May 14, 2013 by Pierre Cazenave
Show whitespace changes
Inline Side-by-side

Showing with 3 additions and 0 deletions

fvcom_prepro/get_NCEP_forcing.m fvcom_prepro/get_NCEP_forcing.m +3 -0

No files found.
--- a/fvcom_prepro/get_NCEP_forcing.m
+++ b/fvcom_prepro/get_NCEP_forcing.m
@@ -40,6 +40,9 @@ function data = get_NCEP_forcing(Mobj, modelTime)
 % calculated from the mean daily latent heat net flux (lhtfl) at the
 % surface.
 %
+% EXAMPLE USAGE:
+%   forcing = get_NCEP_forcing(Mobj, [51345, 51376]);
+%
 % REQUIRES:
 %   The air_sea toolbox:
 %       http://woodshole.er.usgs.gov/operations/sea-mat/air_sea-html/index.html