Allow comments in Project Variables

Options
Marlan
Marlan Neuron 2020, Neuron, Registered, Dataiku Frontrunner Awards 2021 Finalist, Neuron 2021, Neuron 2022, Dataiku Frontrunner Awards 2021 Participant, Neuron 2023 Posts: 316 Neuron

It would be great to be able to specify comments when specifying project variables.

I use project variables often and in typical project may have a half dozen or more variables. While there are many advantages to using variables over hard coding key parameters, I do struggle keeping track of what the variables mean, how they are used, and what values are valid. Especially when returning to a project after some time. Without any documentation, I often end up spending a chunk of time with the global search to review usage of the variables.

One could document the variables in a wiki page and I have done that but it's inconvenient and easy to forget to update it.

One could also use this workaround.

But it sure be great if one could simply specify comments directly in the project variable definitions.

I've been doing more plugin development recently and have really appreciated the ability to specify comments within the plugin JSON files (both the // and the /* */ comment types). Since DSS knows how to deal with comments in plugin JSON files, it seems like this ability could be extended to variable JSON specifications without too much effort.

Thank you,

Marlan

1
1 votes

Duplicate · Last Updated

Comments

Setup Info
    Tags
      Help me…