grimoirelab-tutorial
grimoirelab-tutorial copied to clipboard
This change moves the `optional` and `suggested` comments
Reason for this change: as reported on Slack, mordred consumes comments as part of the configured value, so folks who copy-paste configuration from the documentation run into cryptic errors, for example:
setup.cfg
[${section}]
${setting} = [item-1, item-2] # (optional)
Error:
Error while consuming configuration: Wrong type for section param: ${section} ${setting} <class 'str'> should be <class 'list'>
Removing the comment # (optional) fixes this issue.
Hi @ggolin, do you need any help for completing this?
Let me know if it’s okay for me to take it up, as it has been a pressing issue for a long time.