Go over all OPAL's config variables and add descriptions

[asafc]

Confi (our configuration lib) allows each config var to have a description string. All strings should be well explained and documented.

The acceptance criteria for this issue (updated September 2024):

• Add a test that fails in case of missing description attribute in any of the confi variables in the following configuration files
• Ensure the test is passing
• Add descriptive description to any of the missing description attributes

Config files: https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py https://github.com/permitio/opal/blob/master/packages/opal-client/opal_client/config.py https://github.com/permitio/opal/blob/master/packages/opal-server/opal_server/config.py

[money8203]

Want me to handle the project's documentation @asafc ?

[orweis]

@money8203 for sure, we'd appreciate a hand - you can find the relevant files here:

• https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py
• https://github.com/permitio/opal/blob/master/packages/opal-client/opal_client/config.py
• https://github.com/permitio/opal/blob/master/packages/opal-server/opal_server/config.py

[money8203]

So what in specific do I have to add or document ?

[orweis]

As you can see each config value is defined via confi - e.g. calls to confi.model() or confi.bool() Some of these are missing the "description" argument - which should contain human readable text explaining about the configuration value.

Some of these can be deduced from the variable name, some from the comments in the code, and some would require reading the code itself to explain.

[money8203]

358

I've added some descriptions for this file https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py

[gemanor]

/bounty 50

[algora-pbc[bot]]

💎 $50 bounty • Permit.io

Steps to solve:

1. Start working: Comment /attempt #40 with your implementation plan
2. Submit work: Create a pull request including /claim #40 in the PR body to claim the bounty
3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to permitio/opal!

Add a bounty • Share on socials

[Bhavyajain21]

Is this issue still open? I see a PR merged on it @gemanor

[gemanor]

@Bhavyajain21 we added new acceptance criteria, see the first message in the thread