Skip to content

Conversation

natashamm
Copy link
Contributor

@natashamm natashamm commented Oct 17, 2025

Description

Issue #742 for vDatetime. I also moved some of the docstrings/examples for the from_ical method for vDatetime to match the docstrings for the other properties.

Checklist

  • I've added a change log entry to CHANGES.rst.
  • I've added or updated tests if applicable.
  • I've run and ensured all tests pass locally by following Running Tests.
  • I've added or edited documentation, both as docstrings to be rendered in the API documentation and narrative documentation, as necessary.
  • I've added myself to docs/credits.rst as a contributor in this pull request or have done so previously.

📚 Documentation preview 📚: https://icalendar--917.org.readthedocs.build/

@coveralls
Copy link

Pull Request Test Coverage Report for Build 18580240887

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.838%

Totals Coverage Status
Change from base Build 18555550103: 0.0%
Covered Lines: 7940
Relevant Lines: 8107

💛 - Coveralls

- Fix duplicate blank issue template by adding config.yml to disable GitHub's default blank option. See `Issue 777 <https://github.com/collective/icalendar/issues/777>`_.
- Add PEP 561 py.typed marker to enable type checking support. The package now distributes inline type annotations for mypy and other type checkers. See `Issue 395 <https://github.com/collective/icalendar/issues/395>`_.
- Bump ``github/codeql-action`` from 3 to 4 in CI fuzzing workflow.
- Add ``__doc__`` string documentation for ``vDatetime``. See `Issue 742 <https://github.com/collective/icalendar/issues/742>`_.
Copy link
Member

Choose a reason for hiding this comment

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

This is the more familiar term.

Suggested change
- Add ``__doc__`` string documentation for ``vDatetime``. See `Issue 742 <https://github.com/collective/icalendar/issues/742>`_.
- Add docstring for ``vDatetime``. See `Issue 742 <https://github.com/collective/icalendar/issues/742>`_.

tzinfo component, if present. Otherwise a timezone-naive object is
created. Be aware that there are certain limitations with timezone naive
DATE-TIME components in the icalendar standard.
"""Date-Time
Copy link
Member

Choose a reason for hiding this comment

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

Please take a look at how this renders at https://icalendar--917.org.readthedocs.build/en/917/api.html#icalendar.prop.vDatetime. You'll see it doesn't follow the patterns of existing property docstrings, such as https://icalendar--917.org.readthedocs.build/en/917/api.html#icalendar.prop.vDate. Please build the docs locally to review and test before pushing commits to correct the display issues. Thank you!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants