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

Fix batch email configuration docs #3296

Merged
merged 3 commits into from
Jul 13, 2024

Conversation

ccmaymay
Copy link
Contributor

@ccmaymay ccmaymay commented Jul 11, 2024

Fix batch_email section name, email_interval parameter name in configuration docs.

I don't think there's much to test; I have been trying to get email notifications working in an application, and they only started working as expected once I discovered these documentation errors and corrected the section/parameter names in my code.

Closes #3293, #3294.

@ccmaymay ccmaymay requested review from dlstadther and a team as code owners July 11, 2024 16:25
Copy link
Collaborator

@dlstadther dlstadther left a comment

Choose a reason for hiding this comment

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

The docs referenced the config section and name that would have been used by the original configuration system (which was deprecated but not fully cleaned up; I had actually cleaned up this deprecation in the scheduler). You can see here that the email_interval had a config_path which referenced the section and name from the docs. However, in 2015 the original Luigi author updated the config section parsing to default to the config class name and its property names.

Once the CI completes (i updated this branch with master to resolve an issue with CI), I'll merge.

@dlstadther dlstadther merged commit 618d777 into spotify:master Jul 13, 2024
48 checks passed
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.

In configuration docs, email_interval_minutes should be email_interval
2 participants