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

Correct bad DX/UX of configuration #46

Merged
merged 1 commit into from
May 22, 2024
Merged

Correct bad DX/UX of configuration #46

merged 1 commit into from
May 22, 2024

Conversation

AbstractUmbra
Copy link
Collaborator

@AbstractUmbra AbstractUmbra commented May 22, 2024

Description

With the existing setup, our config allows for child keys to be optional, meaning a parent key is required but can be empty?

[REDIS]
# no child keys

[OTHER_KEY]
some_key = some_value

I doubt this can cause parsing issues but it doesn't look particularly good.
This PR corrects this, meaning the parent key is now the optional one, not the child keys. If the parent key is present then the child keys are required.

Checklist

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
    • I have updated the changelog with a quick recap of my changes.
  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)
  • I have read and agree to the Developer Certificate of Origin for this contribution

@AbstractUmbra AbstractUmbra requested a review from EvieePy May 22, 2024 13:09
@AbstractUmbra AbstractUmbra merged commit 5cb705a into main May 22, 2024
4 checks passed
@AbstractUmbra AbstractUmbra deleted the fix/config branch May 22, 2024 13:42
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.

2 participants