Project

General

Profile

Documentation of key=value parameters

Added by Elio Campitelli 17 days ago

I noticed that some of the operators that use key=values pairs for parameters have slightly inconsistent documentation.

eca_tr, eca_su, eca_rx5day, eca_cdd and eca_cwd have "params" in the Synopsis, but then the description says "Parameter is a comma-separated list of “key=values” pairs". Maybe they should use "parameters".

eca_rx1day, eca_id and eca_hwfi have the same description, but their Synopsis doesn't include a "params" or "parameter" entry. eca_hwfi's synopsis is `cdo <operator>[,nday[,freq]] infile1 infile2 outfile`. Is the correct usage `cdo eca_hwfi,nday=4 ...`? should those operators be documented as `cdo <operator>[,parameter] ...`?


Replies (1)

RE: Documentation of key=value parameters - Added by Elio Campitelli 17 days ago

I've also found that splitcode's synopsis uses "parameters" but the description says "params"

    (1-1/1)