VSCode plugin could output fill-in template #27510
Labels
C: Framework
C: WASP
Tickets pertaining to the WASP submodule
T: task
An enhancement to the software.
Motivation
Some objects, like actions and physics, have a longer list of parameters. It would be much easier if a template to be filled could be spawned by the VSCode plugin, rather than relying on auto-complete to fetch the required parameters one by one
Design
Some command (maybe ctrl T?) could spawn all the required parameters of an object, with an empty field to fill.
(another idea: Alternatively, we could spawn these templates by parameter groups)
The parameters should be sorted by parameter group for readability, and parameter groups would be separated by a line break. Maybe the name of the parameter group would be included as a header for the group of parameters. Maybe users could decide how 'verbose' the templates should be
Achieving something like this:
NB: the action being what it is, most of these parameters are actually not required. But the physics have more required parameters due to not turning off equations with booleans
One question: do we include parameters with a default already?
I think it could be confusing. For example for the NSFVAction, if 'add_scalar_equation' is kept to false, then spawning the ten parameters for the scalar equation in the input would not be great.
If we spawn parameters-to-fill by parameter groups rather than all-the-required-ones-at-once, then I could see us adding the pre-filled parameters with defaults
Impact
Better usability.
Easier time using these large actions
@brandonlangley @dschwen @loganharbour
The text was updated successfully, but these errors were encountered: