8000 Clean up unicode URLs by PPsyrius · Pull Request #2580 · vacanza/holidays · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Clean up unicode URLs #2580

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
May 31, 2025
Merged

Clean up unicode URLs #2580

merged 5 commits into from
May 31, 2025

Conversation

PPsyrius
Copy link
Collaborator
@PPsyrius PPsyrius commented May 29, 2025 •
edited
Loading

Proposed change

Cleaning up all %XX from encoded to proper literal/unencoded versions for reference links, with the exception of %20 (SPACE). All cleanup'ed links have been manually verified to be accessible.

Non-Wikipedia/GitHub archival links are also updated accordingly in #2504.

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 coderabbitai
Copy link
Contributor
coderabbitai bot commented May 29, 2025 •
edited
Loading

Summary by CodeRabbit

  • Documentation
    • Improved readability of reference URLs in documentation and comments by replacing percent-encoded characters with their actual Unicode equivalents across multiple countries and holiday groups.
    • Ensured all example and reference links are now more human-readable and consistent in format.
    • No changes to application functionality or user-facing features.

Summary by CodeRabbit

  • Documentation
    • Improved readability of reference URLs in documentation and comments by replacing URL-encoded characters (such as %27, %28, %29, %5F, and %2C) with their literal equivalents (such as ', (, ), _, and ,).
    • Corrected minor formatting issues in documentation links, including adding missing brackets and updating link paths for clarity.
    • No changes to application functionality or logic.

Walkthrough

This update standardizes URL formatting across multiple documentation strings and comments by replacing URL-encoded characters with their literal equivalents. The changes affect reference links in various country and holiday group modules, as well as sponsorship documentation. No functional code or public entity declarations were altered.

Changes

Files Change Summary
SPONSORSHIP.md Updated GitHub issue URLs to use unencoded query parameters and fixed a missing closing bracket in a link.
holidays/countries/aland_islands.py, holidays/countries/finland.py Changed Åland's Autonomy Day reference URL from encoded to literal apostrophe.
holidays/countries/angola.py Updated law reference URLs by replacing encoded parentheses with literal ones.
holidays/countries/ecuador.py, holidays/countries/north_macedonia.py Corrected reference URLs by replacing encoded parentheses with literal parentheses.
holidays/countries/ethiopia.py, holidays/countries/ivory_coast.py, holidays/countries/tuvalu.py, holidays/countries/united_states.py Updated reference URLs by changing encoded apostrophes to literal apostrophes.
holidays/countries/kazakhstan.py Replaced encoded underscores in reference URLs with literal underscores.
holidays/countries/togo.py Updated comment URLs by replacing encoded commas with literal commas.
holidays/countries/trinidad_and_tobago.py Changed an archived Facebook post URL from encoded to unencoded format.
holidays/groups/chinese.py, holidays/groups/christian.py, holidays/groups/international.py, holidays/groups/islamic.py Updated Wikipedia reference URLs in docstrings to use literal apostrophes instead of encoded ones.
holidays/countries/argentina.py, holidays/countries/azerbaijan.py, holidays/countries/belgium.py, holidays/countries/chile.py, holidays/countries/curacao.py, holidays/countries/dominican_republic.py, holidays/countries/equatorial_guinea.py, holidays/countries/italy.py, holidays/countries/mexico.py, holidays/countries/morocco.py, holidays/countries/norway.py, holidays/countries/panama.py, holidays/countries/paraguay.py, holidays/countries/slovenia.py, holidays/countries/sweden.py, holidays/countries/ukraine.py, holidays/countries/venezuela.py Corrected URLs in docstrings and comments by replacing percent-encoded accented or special characters with their literal UTF-8 equivalents for better readability.

Suggested labels

doc

Suggested reviewers

  • PPsyrius
  • KJhellico
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc40f49 and 144ca53.

📒 Files selected for processing (1)
  • SPONSORSHIP.md (1 hunks)
⏰ Context from checks skipped due to timeout of 300000ms (1)
  • GitHub Check: Test build on windows-latest
🔇 Additional comments (1)
SPONSORSHIP.md (1)

58-58: URL decoding in query parameters is clear—please verify resolution

Replacing %3A/%22 with literal :/" enhances readability and consistency. Double-check that these literal characters work correctly in GitHub’s issue search query (colons are allowed in the query string) and that the final link’s parentheses remain balanced.

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov Codecov
Copy link
codecov bot commented May 29, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d7d2f27) to head (144ca53).
Report is 2 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff            @@
##               dev     #2580   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          224       224           
  Lines        14315     14315           
  Branches      2010      2010           
=========================================
  Hits         14315     14315

☔ 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.

@KJhellico
Copy link
Collaborator

I've added more Unicode characters. :)

@PPsyrius PPsyrius mentioned this pull request May 30, 2025
Merged
9 tasks
@PPsyrius
Copy link
Collaborator Author

@KJhellico I've fixed up one of the UA links that you might have over-corrected, and porting these changes to #2504 - that should be all of the remaining ones I hope 🙏

KJhellico
KJhellico previously approved these changes May 30, 2025
View reviewed changes
Copy link
Collaborator
@KJhellico KJhellico 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 changed the title Link Unicode Cleanups Clean up unicode URLs May 31, 2025
@sonarqubecloud SonarQubeCloud
Copy link

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

arkid15r
arkid15r approved these changes May 31, 2025
View reviewed changes
Copy link
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 didn't check all the URLs but random set of about 10 URLs worked just fine.

LGTM, great clean up 👍

// we probably should introduce a URL checker job into CI/CD at some point.

@arkid15r arkid15r enabled auto-merge May 31, 2025 16:36
@arkid15r arkid15r added this pull request to the merge queue May 31, 2025
Merged via the queue into vacanza:dev with commit 7ebe5bf May 31, 2025
33 checks passed
@arkid15r arkid15r mentioned this pull request Jun 2, 2025
Merged
@PPsyrius PPsyrius deleted the link_cleanup branch June 4, 2025 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arkid15r arkid15r arkid15r approved these changes

@KJhellico KJhellico KJhellico left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@PPsyrius @KJhellico @arkid15r
0