Update l10n related documentation: detailed explain of language parameter behavior #2396

shreyanshVIT23 · 2025-03-31T16:21:20Z

Proposed change

Updating the documentation for the language parameter by updating the docstrings in the following locations:

country_holidays function
financial_holidays function (located in holidays/utils.py)
HolidayBase class (located in holidays/holiday_base.py)

The updates ensure that the purpose and usage of the language parameter are clearly explained.

Issue Fixed

Fixes #2225

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

I've followed the contributing guidelines
I've successfully run make check, all checks and tests are green

…lidayBase to better explain the language parameter based on the current code base

…lidays into fix-2225-issue

coderabbitai · 2025-03-31T16:21:30Z

Summary by CodeRabbit

Documentation
- Expanded and clarified documentation for the language parameter in holiday-related functions and classes, including details on supported formats, fallback behavior, and environment variable detection. Added recommendations for consistent usage.
Chores
- Added "Shreyansh Pande" to the list of authors.

Summary by CodeRabbit

Documentation
- Expanded and clarified documentation for the language parameter in holiday-related classes and functions, including details on accepted formats, fallback mechanisms, and recommendations for consistent behavior.
Chores
- Added "Shreyansh Pande" to the list of authors.

Walkthrough

This pull request updates documentation and adds a new author entry. The AUTHORS.md file now includes "Shreyansh Pande" at the end of the author list. In the code, the documentation for the language parameter has been enhanced in both the HolidayBase class and utility functions. The changes clarify acceptable language formats (ISO 639-1 and ISO 3166-1 combinations), system fallback behaviors based on environment locale variables, and include formatting adjustments for readability.

Changes

File(s)	Change Summary
AUTHORS.md	Added new author "Shreyansh Pande" immediately after "Sho Hirose" and before "Simon Gurcke".
holidays/holiday_base.py, holidays/utils.py	Enhanced documentation for the `language` parameter by specifying acceptable ISO codes and fallback behavior based on environment locale variables; added warnings and usage recommendations.

Assessment against linked issues

Objective	Addressed	Explanation
Update l10n related documentation (#2225)	✅

Possibly related PRs

Add French Southern Territories holidays #2442: Also adds a new author to AUTHORS.md, similar to this PR’s update of contributor names.

Suggested labels

l10n

Suggested reviewers

KJhellico

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 aebcd69 and 19ca508.

📒 Files selected for processing (1)

AUTHORS.md (1 hunks)

⏰ Context from checks skipped due to timeout of 300000ms (1)

GitHub Check: Test build on ubuntu-latest

🔇 Additional comments (1)

AUTHORS.md (1)

137-137: LGTM – new author added! The entry for “Shreyansh Pande” is correctly placed in alphabetical order alongside existing authors. Thanks for the contribution.

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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

arkid15r

Please run checks/tests and make sure to include relevant changes only.

Thank you!

…lidays into fix-2225-issue

shreyanshVIT23 · 2025-04-04T15:41:11Z

I have fixed the ruff format issue. Please check if there are any other issues.

codecov · 2025-04-04T16:05:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (eaaab10) to head (19ca508).
Report is 1 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff            @@
##               dev     #2396   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          214       214           
  Lines        13527     13527           
  Branches      1928      1928           
=========================================
  Hits         13527     13527

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

holidays/holiday_base.py

…rmatting

holidays/holiday_base.py

holidays/utils.py

…able and removed the formatting changes in utils.py

coderabbitai

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 884024d and 9bf4e9a.

📒 Files selected for processing (2)

holidays/holiday_base.py (1 hunks)
holidays/utils.py (3 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

holidays/utils.py (1)

holidays/registry.py (2)

EntityLoader (206-300)

get_financial_codes (282-288)

🪛 Ruff (0.8.2)

holidays/utils.py

417-417: No newline at end of file

Add trailing newline

(W292)

🔇 Additional comments (3)

holidays/utils.py (2)

73-94: Great improvement to the language parameter documentation!

The updated docstring provides clear, detailed information about how the language parameter works. The explanation of ISO codes, fallback behavior, and environment consistency considerations is very helpful for users.

254-273: Good consistency in documentation between functions.

The explanation for the language parameter in financial_holidays mirrors the one in country_holidays, which ensures consistent documentation throughout the codebase.

holidays/holiday_base.py (1)

293-312: Clear and consistent language parameter documentation.

The updated documentation provides excellent guidance on the language parameter's expected format and behavior. It effectively explains:

Valid language code formats (ISO 639-1 and combinations with ISO 3166-1)

The fallback behavior based on the LANG environment variable

Potential inconsistencies between different environments

Best practices for ensuring consistent results

This matches the documentation in the utils.py file, providing a consistent experience across the codebase.

holidays/utils.py

KJhellico

LGTM.

sonarqubecloud · 2025-04-18T18:34:42Z

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

Done.

shreyanshVIT23 added 3 commits March 31, 2025 21:26

Clarified docstrings for country_holidays, financial_holidays, and Ho…

a56c7c3

…lidayBase to better explain the language parameter based on the current code base

Clarified docstrings for country_holidays, financial_holidays, and Ho…

efe7d06

…lidayBase to better explain the language parameter based on the current code base

Merge branch 'fix-2225-issue' of https://github.com/shreyanshVIT23/ho…

1928caf

…lidays into fix-2225-issue

shreyanshVIT23 requested review from arkid15r, KJhellico and PPsyrius as code owners March 31, 2025 16:21

arkid15r marked this pull request as draft April 3, 2025 21:07

arkid15r previously requested changes Apr 4, 2025

View reviewed changes

shreyanshVIT23 added 3 commits April 4, 2025 20:35

Merge branch 'dev' into fix-2225-issue

348ae07

Fix formatting with ruff

4f3542e

Merge branch 'fix-2225-issue' of https://github.com/shreyanshVIT23/ho…

64a0300

…lidays into fix-2225-issue

shreyanshVIT23 marked this pull request as ready for review April 4, 2025 15:35

KJhellico reviewed Apr 4, 2025

View reviewed changes

holidays/holiday_base.py Outdated Show resolved Hide resolved

holidays/holiday_base.py Outdated Show resolved Hide resolved

holidays/holiday_base.py Outdated Show resolved Hide resolved

holidays/holiday_base.py Outdated Show resolved Hide resolved

updated for langyage parameter documentation and removed redundant fo…

884024d

…rmatting

KJhellico reviewed Apr 6, 2025

View reviewed changes

holidays/holiday_base.py Outdated Show resolved Hide resolved

holidays/holiday_base.py Outdated Show resolved Hide resolved

holidays/utils.py Outdated Show resolved Hide resolved

updated lang paramter to explicitly tell user to set environment vari…

9bf4e9a

…able and removed the formatting changes in utils.py

coderabbitai bot reviewed Apr 6, 2025

View reviewed changes

holidays/utils.py Outdated Show resolved Hide resolved

shreyanshVIT23 and others added 8 commits April 6, 2025 20:47

added new line at end

f9232ce

Merge branch 'dev' into fix-2225-issue

692f793

Merge branch 'dev' into fix-2225-issue

d5a5ad3

Update code

6aab080

Merge branch 'dev' into pr/shreyanshVIT23/2396

cc40490

Update formatting

21e0074

Merge branch 'dev' into pr/shreyanshVIT23/2396

8ec1a22

Update code

aebcd69

arkid15r requested a review from KJhellico April 18, 2025 03:29

KJhellico changed the title ~~Fix 2225 issue: Update docstring to correctly explain behavior of how the language parameter works~~ Update l10n related documentation: detailed explain of language parameter behavior Apr 18, 2025

KJhellico approved these changes Apr 18, 2025

View reviewed changes

Merge branch 'dev' into fix-2225-issue

19ca508

arkid15r enabled auto-merge April 18, 2025 18:33

arkid15r added this pull request to the merge queue Apr 18, 2025

Merged via the queue into vacanza:dev with commit 3d0c72c Apr 18, 2025
33 checks passed

KJhellico mentioned this pull request Apr 21, 2025

v0.71 #2485

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Update l10n related documentation: detailed explain of language parameter behavior #2396

Update l10n related documentation: detailed explain of language parameter behavior #2396

Uh oh!

shreyanshVIT23 commented Mar 31, 2025 •

edited by PPsyrius

Loading

Uh oh!

coderabbitai bot commented Mar 31, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

arkid15r left a comment

Uh oh!

shreyanshVIT23 commented Apr 4, 2025

Uh oh!

codecov bot commented Apr 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

KJhellico left a comment

Uh oh!

sonarqubecloud bot commented Apr 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Update l10n related documentation: detailed explain of language parameter behavior #2396

Update l10n related documentation: detailed explain of language parameter behavior #2396

Uh oh!

Conversation

shreyanshVIT23 commented Mar 31, 2025 • edited by PPsyrius Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Issue Fixed

Type of change

Checklist

Uh oh!

coderabbitai bot commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

arkid15r left a comment

Choose a reason for hiding this comment

Uh oh!

shreyanshVIT23 commented Apr 4, 2025

Uh oh!

codecov bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

KJhellico left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Apr 18, 2025

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

shreyanshVIT23 commented Mar 31, 2025 •

edited by PPsyrius

Loading

coderabbitai bot commented Mar 31, 2025 •

edited

Loading

codecov bot commented Apr 4, 2025 •

edited

Loading