Skip to content

Update documentation: remove mixins from summary#3094

Merged
arkid15r merged 1 commit intovacanza:devfrom
KJhellico:upd-docs-mixins
Nov 30, 2025
Merged

Update documentation: remove mixins from summary#3094
arkid15r merged 1 commit intovacanza:devfrom
KJhellico:upd-docs-mixins

Conversation

@KJhellico
Copy link
Copy Markdown
Collaborator

@KJhellico KJhellico commented Nov 29, 2025 •
edited
Loading

Proposed change

Reorganize summary a bit: remove Mixins, move Changelog up in the list.

Type of change

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Nov 29, 2025 •
edited
Loading

Summary by CodeRabbit

  • Documentation
    • Removed the Mixins documentation section
    • Updated documentation navigation structure and consolidated changelog reference placement for improved organization

✏️ Tip: You can customize this high-level summary in your review settings.

Walkthrough

Documentation was simplified by removing the mixins documentation file and reorganizing the documentation summary structure. The Changelog link was consolidated to appear at the top of SUMMARY.md, and the Mixins entry was removed.

Changes

Cohort / File(s) Summary
Documentation Deletion
docs/mixins.md		 File deleted; removed Mixins section and holidays.mixins directive
Documentation Structure Updates
scripts/docs/gen_summary.py		 Added Changelog link near the top of SUMMARY.md, removed Mixins entry, and removed duplicate Changelog entry at the end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify that the mixins documentation removal was intentional and complete
  • Confirm the Changelog link consolidation in SUMMARY.md is correctly positioned
  • Ensure no other references to the removed mixins documentation exist elsewhere in the codebase

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: removing mixins from the documentation summary.
Description check ✅ Passed The description clearly outlines the reorganization of the summary—removing Mixins and moving Changelog up—which aligns with the actual file changes.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14928c8 and d7d3e0f.

📒 Files selected for processing (2)
  • docs/mixins.md (0 hunks)
  • scripts/docs/gen_summary.py (1 hunks)
💤 Files with no reviewable changes (1)
  • docs/mixins.md
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings 
Learnt from: KJhellico
Repo: vacanza/holidays PR: 2653
File: holidays/locale/th/LC_MESSAGES/TW.po:17-21
Timestamp: 2025-06-21T18:06:50.027Z
Learning: KJhellico's username includes a tilde character (~) as part of their nickname (appears as "~Jhellico" in Last-Translator headers), which is intentional formatting and not an error.
⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: Test Python 3.13 on windows-latest
  • GitHub Check: Test Python 3.10 on windows-latest
  • GitHub Check: Test Python 3.11 on windows-latest
  • GitHub Check: Test Python 3.14 on windows-latest
  • GitHub Check: Test Python 3.12 on windows-latest
🔇 Additional comments (1)
scripts/docs/gen_summary.py (1)

27-27: Changelog link placement looks good, and the addition is clean and positioned appropriately in the documentation structure.

However, verify that all mixins-related entries have been fully removed from the documentation generation by checking for any remaining mixin references in scripts/docs/, docs/, and confirming docs/mixins.md no longer exists or has been properly removed.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 29, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (aafa8e1) to head (d7d3e0f).
⚠️ Report is 2 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff            @@
##               dev     #3094   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          306       306           
  Lines        18085     18085           
  Branches      2311      2311           
=========================================
  Hits         18085     18085

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

PPsyrius
PPsyrius previously approved these changes Nov 30, 2025
View reviewed changes
arkid15r
arkid15r reviewed Nov 30, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

I'm not sure how useful it'd be for end users as it's our internal helper.

@KJhellico @PPsyrius if you both think it should be visible via API docs I'm okay with adding it.

@KJhellico
Copy link
Copy Markdown
Collaborator Author

KJhellico commented Nov 30, 2025

I'm not sure how useful it'd be for end users as it's our internal helper.

Hmm, it sounds rational. Then, wouldn't it be better to remove it from the documentation?

@arkid15r
Copy link
Copy Markdown
Collaborator

arkid15r commented Nov 30, 2025

Hmm, it sounds rational. Then, wouldn't it be better to remove it from the documentation?

This seems to be a better way to handle this.

@KJhellico KJhellico changed the title Update documentation: showing mixins list in summary Update documentation: remove mixins from summary Nov 30, 2025
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Nov 30, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

PPsyrius
PPsyrius approved these changes Nov 30, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@PPsyrius PPsyrius left a comment

Choose a reason for hiding this comment

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

LGTM🗒️

@arkid15r arkid15r added this pull request to the merge queue Nov 30, 2025
Merged via the queue into vacanza:dev with commit 8bd4018 Nov 30, 2025
33 checks passed
@KJhellico KJhellico deleted the upd-docs-mixins branch December 1, 2025 13:10
@arkid15r arkid15r mentioned this pull request Dec 1, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arkid15r arkid15r arkid15r left review comments

@PPsyrius PPsyrius PPsyrius approved these changes

Assignees

No one assigned

Labels

doc script

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@KJhellico @arkid15r @PPsyrius