Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add meaning of the variable names #99

Open
natema opened this issue Sep 30, 2022 · 0 comments
Open

Add meaning of the variable names #99

natema opened this issue Sep 30, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation newfeature New feature or request

Comments

@natema
Copy link
Member

natema commented Sep 30, 2022

We have a nice table in the documentation with all the variables.
It would be useful to add a column with what the acronym means.

Actually, it would be even nicer to provide such names in the variable metadata:
MTK allows to provide a description when defining a variable, that can be retrieved from the system:

@variables u [description = "This is my input"]
@natema natema added documentation Improvements or additions to documentation newfeature New feature or request labels Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation newfeature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant