Open phargogh opened 2 years ago
Back when I deduplicated all the ARGS_SPEC and user's guide content in order to implement the custom sphinx role (PRs natcap/invest.users-guide#42, natcap/invest.users-guide#45, natcap/invest.users-guide#47, natcap/invest#604, natcap/invest#633, natcap/invest#639) I merged the arg description content following these guidelines:
about
text should not duplicate anything that's stored in another spec property (units, projection, etc)
The goal was to keep the spec as short as possible and leave the user's guide open for any other info. My reasoning was
evapotranspiration_1.tif
, but that can't be done in the spec.about
text are: (1) tooltip text in the UI and (2) quick reference for us when reading the model code. Keeping it brief makes sense for both those purposes.These guidelines are opinionated but I'm sure we discussed it when I worked on those PRs. Happy to discuss further - maybe changes to the about
text/UG split are warranted now that we've seen what this first implementation is like. And we're bound to have different ideas about what the "minimum necessary information" is so that would be good to clarify.
We started an interesting discussion over in https://github.com/natcap/invest/pull/895 about the amount of information that should live in the ARGS_SPEC about text. In Seasonal Water Yield, there are several inputs where files are expected to have filenames matching a pattern that identifies the month the file represents (e.g. precip or ET0 for January). How much information should be in the about text vs in the user's guide?
Once we arrive at a decision about this, it might be useful to add to the InVEST spec.