docs: convert timezone.py docstrings to Google style#1387
Open
Godzilaa wants to merge 1 commit into
Open
Conversation
Godzilaa
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
Documentation build overview
3 files changed± 404.html± reference/api/icalendar.cal.timezone.html± _modules/icalendar/cal/timezone.html |
Member
|
@Godzilaa would you please add a change log entry per https://icalendar.readthedocs.io/en/stable/contribute/index.html#change-log-entry-format, and update your branch with |
stevepiercy
requested changes
May 21, 2026
Member
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
Thank you for your contribution! I found a few issues with the original docstrings during my review, as well as a few minor suggestions and corrections. Would you please take care to address them? Thank you!
Convert old :param/:raises Sphinx-style docstrings in timezone.py to Google-style docstrings matching the project style guide. Functions updated: - _extract_offsets - _make_unique_tzname - to_tz - from_tzinfo - from_tzid Contributes to collective#1072 Used AI model: opencode/deepseek-v4-flash-free Used for: converting Sphinx-style docstrings to Google-style, fixing duplicate parameter in from_tzid, adding changelog entry, and fixing line length formatting.
Godzilaa
force-pushed
the
fix/google-style-docstrings-timezone
branch
from
20ceb7d to
4385d4c
Compare
Author
|
I've rebased the branch on latest main, added a changelog entry (news/1072.documentation), fixed the duplicate |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Convert old
:param/:raisesSphinx-style docstrings intimezone.pyto Google-style docstrings matching the project style guide.
Functions updated:
_extract_offsets_make_unique_tznameto_tzfrom_tzinfofrom_tzidContributes to #1072