-
Notifications
You must be signed in to change notification settings - Fork 42
03_Questions: YAML
Tdannen edited this page Dec 16, 2015
·
6 revisions
Q1: What is the benefit of using YAML format?
A1: If you format your "metainfo.txt" according to YAML, we are able to automatically create a Readme.md and add it to your repository. This saves you the time to do it by yourself.
Q2: Some of my datafields include lists of variables with an extra description. Is there a way to properly include them with YAML, which is also ok with your styleguide?
A2: If you want to include descriptions for your variables, you can do this as followed:
Input:
- t : time points
Output:
- k : kernel function
As you can see, an additional description for variable t and k has been added. Please make sure to use the correct syntax as shown in this short example. This allows us to automatically create the Readme.md.