OpenCDSS / cdss-lib-processor-ts-java

Colorado's Decision Support Systems (CDSS) time series processor library (Java)
GNU General Public License v3.0
0 stars 1 forks source link

Add Description parameter to commands that change description #71

Open smalers opened 4 years ago

smalers commented 4 years ago

Some commands modify the time series description automatically, in order to indicate a manipulation that differentiates the time series from another. This can be problematic when the auto-updated description is not "nice" and can be long, for example from Add. In these cases, a new command parameter Description (or similar) could be added, with default being to auto-update, but allowing the description to be set by the user. Time series properties like ${ts:description} could be recognized to allow manipulating the existing description. The new default could be to not modify the description and users could specify new description information if they have an interest.

Also, the functionality of changing the description is a historical artifact that was added early on. Later, time series were updated to have a history of changes, which can be viewed and output in some formats. Changing the description automatically is not needed in most cases because the history records the changes. Some commands also allow the modified value to be flagged and such functionality can be phased into more commands as the auto-modified description is phased out.

Changes could be phased in to a few commands first and get feedback from users.

smalers commented 1 year ago

Here is an example of what the description looks like after the "remove" action. A similar string is used in graph legend. It does not really help users much, especially when multiple commands manipulate the time series. I'm in the process of removing the auto description from the ReplaceValue command and allowing the user to set a description if they want.

image