export_plots_timeout: Add docs and increase default to 60s#3433
Conversation
ewels
commented
Dec 11, 2025
- Document the export_plots_timeout config option in the docs
- Increase default timeout from 30s to 60s to reduce timeouts with Kaleido
- Update config schema description to be more informative
- Regenerate JSON schema
- Document the export_plots_timeout config option in the docs - Increase default timeout from 30s to 60s to reduce timeouts with Kaleido - Update config schema description to be more informative - Regenerate JSON schema
PR Review: Add documentation for export_plots_timeout and increase default to 60sSummary: This is a well-structured PR that improves user experience by increasing the timeout for plot exports and adding comprehensive documentation. The changes are minimal, focused, and address a real pain point with Kaleido timeouts. ✅ Approved with minor formatting fixes needed. Detailed Review✅ Code Quality and Best PracticesExcellent:
Documentation:
🔧 Issues FoundFormatting Issues (CI Failures):
To fix: Run 🎯 Potential ImprovementsSchema Description (multiqc/utils/config_schema.py:128): # Current:
description="Timeout in seconds for exporting each plot to a static image (default: 60)"
# Suggestion:
description="Timeout in seconds for exporting each plot to a static image. Kaleido can occasionally hang; if timeout is exceeded, plot export is skipped and report generation continues. Default: 60"This would match the detailed explanation in the documentation and provide context for why the timeout exists. ⚡ Performance ConsiderationsPositive Impact:
No Concerns:
🔒 Security ConsiderationsNo Issues:
🧪 Test CoverageObservations:
Recommendation (Optional):
However, this is not critical for this PR since it's a straightforward config change. 📝 Other NotesChanges Summary:
Commit Message: 🎬 Action Items
|
export_plots_timeout: Add docs and increase default to 60s