-
Notifications
You must be signed in to change notification settings - Fork 1
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
added the importance: required|recommended|optional to each of the fi… #39
base: main
Are you sure you want to change the base?
Conversation
…elds in the md files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello Virag, I noticed that the script does not appear to have been updated to reflect the changes you intended for the data_dictionary
files. These files are autogenerated by the update_metadata_docs.py
script located in the scripts folder, which should have been modified accordingly.
…d the same in the sheet_documentation_template.md.jinja
Hi Bilge, Please note that I have renamed the slot "importance" to "significance" now. Everything else remains the same. Thanks |
Hi Virag, thanks for adding this missing information. My idea would be to deprecate the "required: True / False" flag in the documentation and change the "significance" to "requirement", which can take one of "optional / recommended / required" to avoid redundancy. As an visual aid, "required" could be highlighted with a different text color (if possible). What do you think? |
Co-authored-by: sbilge <[email protected]>
…ng scheme for different slots - red for required, blue for recommended, green for optional fields. The required field is deprecated. The requirement field is introduced now
Hi Karo, So we now have the field/slot called requirement which can take one of the three values:
The template file has been modified accordingly. |
Added the "importance" field in the markdown files corresponding to the individual sheets in the ghga_submission_full.xlsx
Understandably, the importance field could take one of three values:
As of now, there is only one field "required" which is a boolean (True|False), which is also not so intuitive for experimentalists/people working on the bench.