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

This change moves the optional and suggested comments #231

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ggolin
Copy link

@ggolin ggolin commented Jul 12, 2024

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.

Copy link
Member

@sduenas sduenas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR looks good to me but can you add to the commit the Signed-off trailer? All contributions need to be signed: https://github.com/chaoss/grimoirelab/blob/master/CONTRIBUTING_WITH_CODE.md#developer-certificate-origin

Thanks!

@vchrombie
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants