Repository navigation
Convert the TypesFactory.to_ical docstring to Google style - #2159
Open
sneha-shukla-dev wants to merge 1 commit into
Open
sneha-shukla-dev wants to merge 1 commit into
sneha-shukla-dev wants to merge 1 commit into
Conversation
The previous docstring was a two-line summary without Parameters or Returns sections. The new wording describes how the method looks up a value type and documents that it returns bytes. AI disclosure: I used an AI assistant (Grok Bot) to help find a function whose docstring still needed converting for issue PyCalendar#1072, that was not already covered by an open pull request, draft Google-style Parameters and Returns sections from the implementation, and prepare the changelog entry. Prompts summarized: search src/icalendar for leftover non-Google docstrings outside files in open PyCalendar#1072 PRs; rewrite TypesFactory.to_ical to match the project style guide; add news/1072.documentation.6 with the required AI disclosure. Output: this commit.
sneha-shukla-dev
requested review from
angatha,
niccokunzmann and
stevepiercy
as code owners
November 19, 2026 11:46
Contributor
|
Thanks for the pull request, @sneha-shukla-dev! A maintainer will review it shortly. |
Contributor
Insufficient dataNot enough activity yet to make a reliable assessment. Evidence
This is an automated analysis by AgentScan |
Contributor
|
One or more PR-quality checks did not pass. Review the PR Quality Checks summary in the workflow run for the failed checks and their details, then make any necessary updates. Checklist items may remain unchecked while work is in progress. Please tick each item as you complete it. If you used AI assistance, follow the project's Responsible AI use policy and provide the required disclosures. |
This branch has not been deployed
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
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.
Linked issue
Description
This converts only the
TypesFactory.to_icaldocstring insrc/icalendar/prop/factory.pyto Google style. The previous text was a two-line summary without Parameters or Returns sections. The new wording describes that the method looks up the value type withfor_propertyand documents that it returnsbytes.I did not change the function signature, body, or the
from_icaldocstring. This is separate from open #1072 work such as #2120 (Component.to_ical), #2110 (vUri.to_ical), and #1749 (parser_toolsandcomponent).Open pull request #2153 also edits
src/icalendar/prop/factory.py, but only the class docstring and__init__, notto_ical. See #2153.I used an AI assistant (Grok Bot) to help identify a function whose docstring was not yet in Google style and was not already covered by an open pull request, draft the Parameters and Returns sections from the implementation, and prepare the changelog entry and this pull request description.
Checklist
Additional information
I did not add new tests. I ran
ruff format --checkandruff checkonsrc/icalendar/prop/factory.py,pytest src/icalendar/tests/test_docstrings.py(1877 passed, 563 xfailed),pytest -k "TypesFactory or types_factory or factory"excluding fuzz tests (213 passed, 2 skipped, 9 xfailed), andsphinx-build -W -b html(build succeeded). I did not run the full tox matrix.The changelog fragment is
news/1072.documentation.6.