Skip to content

Convert the TypesFactory.to_ical docstring to Google style - #2159

Open
sneha-shukla-dev wants to merge 1 commit into
PyCalendar:mainfrom
sneha-shukla-dev:docs/1072-typesfactory-to-ical-docstring
Open

sneha-shukla-dev wants to merge 1 commit into
PyCalendar:mainfrom
sneha-shukla-dev:docs/1072-typesfactory-to-ical-docstring

Conversation

@sneha-shukla-dev

Copy link
Copy Markdown

Linked issue

Description

This converts only the TypesFactory.to_ical docstring in src/icalendar/prop/factory.py to 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 with for_property and documents that it returns bytes.

I did not change the function signature, body, or the from_ical docstring. This is separate from open #1072 work such as #2120 (Component.to_ical), #2110 (vUri.to_ical), and #1749 (parser_tools and component).

Open pull request #2153 also edits src/icalendar/prop/factory.py, but only the class docstring and __init__, not to_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

  • I added a change log entry, following the instructions in all subsections under Change log requirements.
  • I followed icalendar's Artificial intelligence policy and disclosed my Responsible AI use in my commit messages, if applicable.
  • I added or updated tests, if applicable.
  • I ran and ensured all tests pass locally by following Run tests.
  • I added or edited documentation as necessary, both as docstrings to be rendered in the API documentation and narrative documentation, following the Style guide.

Additional information

I did not add new tests. I ran ruff format --check and ruff check on src/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), and sphinx-build -W -b html (build succeeded). I did not run the full tox matrix.

The changelog fragment is news/1072.documentation.6.

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.
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the pull request, @sneha-shukla-dev! A maintainer will review it shortly.

@github-actions

Copy link
Copy Markdown
Contributor

Insufficient data

Not enough activity yet to make a reliable assessment.

View full analysis →

Evidence
  • Recently created: Account is 0 days old

This is an automated analysis by AgentScan

@github-actions github-actions Bot added the ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. label Nov 19, 2026
@github-actions

Copy link
Copy Markdown
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

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

Labels

ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant