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.

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

Update documentation: add supported entities section #1564

Merged
merged 4 commits into from
Nov 23, 2023
Merged

Update documentation: add supported entities section #1564

merged 4 commits into from
Nov 23, 2023

Conversation

arkid15r
Copy link
Collaborator

Proposed change

Update documentation: add supported entities section

  • Disable inherited members for quicker docs generation
  • Fix rough docstring cases
  • Add generated autosummary to .gitignore
  • Reformat pre-commit config
  • Extend make clean with documentation cleanup command

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/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new python-holidays functionality in general)

Checklist

  • I've followed the contributing guidelines
  • I've added references to all holidays information sources used in this PR
  • The code style looks good: make pre-commit command generates no changes
  • All tests pass locally: make test, make tox (we strongly encourage adding tests to your code)

@arkid15r
Update documentation: add supported entities section
6be2810 
  - Disable inherited members for quicker docs generation
  - Fix rough docstring cases
  - Add generated autosummary to .gitignore
  - Reformat pre-commit config
  - Extend make clean with documentation cleanup command
@coveralls
Copy link

coveralls commented Nov 20, 2023 •
edited
Loading

Pull Request Test Coverage Report for Build 6960216461

  • 9 of 9 (100.0%) changed or added relevant lines in 7 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 99.978%
Totals Coverage Status
Change from base Build 6947409011: 0.0%
Covered Lines: 10276
Relevant Lines: 10276
💛 - Coveralls

@KJhellico
Copy link
Collaborator

It looks like we need to fix all links in comments containing Unicode characters, for Sphinx to process them correctly. Currently, links like https://zh.wikipedia.org/wiki/中华人民共和国节日与公众假期 are broken.

@arkid15r
Copy link
Collaborator Author

It looks like we need to fix all links in comments containing Unicode characters, for Sphinx to process them correctly. Currently, links like https://zh.wikipedia.org/wiki/中华人民共和国节日与公众假期 are broken.

Yes, we have quite a few entities with malformed documentation. This is the first step towards fixing that.

KJhellico
KJhellico reviewed Nov 22, 2023
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.

A few more formatting fixes.

holidays/countries/china.py Outdated Show resolved Hide resolved
holidays/countries/portugal.py Outdated Show resolved Hide resolved
holidays/countries/saudi_arabia.py Show resolved Hide resolved
holidays/countries/thailand.py Outdated Show resolved Hide resolved
holidays/countries/thailand.py Outdated Show resolved Hide resolved
holidays/countries/thailand.py Outdated Show resolved Hide resolved
holidays/countries/ukraine.py Outdated Show resolved Hide resolved
@arkid15r @KJhellico
Apply suggestions from code review
d89c64a 
Co-authored-by: ~Jhellico <KJhellico@users.noreply.github.com>
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 22, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
1.0% 1.0% Duplication

arkid15r
arkid15r commented Nov 22, 2023
View reviewed changes
Copy link
Collaborator Author

@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've merged your suggestions 👍

This PR goal is introducing the supported entities docs. We need to make sure RTD builds it successfully. Fixing actual documentation is the next step. I'd also like to reconsider current format for args/returns and links.

KJhellico
KJhellico approved these changes Nov 23, 2023
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.

Then let's try! LGTM 🚀

@arkid15r arkid15r added this pull request to the merge queue Nov 23, 2023
Merged via the queue into vacanza:beta with commit aa78057 Nov 23, 2023
27 checks passed
@arkid15r arkid15r deleted the update-documentation branch November 23, 2023 20:41
@arkid15r arkid15r mentioned this pull request Dec 4, 2023
Merged
phillipuniverse
phillipuniverse reviewed Dec 27, 2023
View reviewed changes
holidays/countries/kazakhstan.py
- https://www.officeholidays.com/countries/kazakhstan/2020
- https://egov.kz/cms/en/articles/holidays-calend
- https://en.wikipedia.org/wiki/Public_holidays_in_Kazakhstan
- https://adilet.zan.kz/rus/docs/Z010000267\_/history # noqa W605
Copy link

Choose a reason for hiding this comment

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

Hm @arkid15r @KJhellico looks like this ignore caused a problem with Python 3.11.4 #1612

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phillipuniverse phillipuniverse phillipuniverse left review comments

@KJhellico KJhellico KJhellico approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@arkid15r @coveralls @KJhellico @phillipuniverse