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.

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

issue-742 #745

Merged
merged 6 commits into from
Nov 21, 2024
Merged

issue-742 #745

merged 6 commits into from
Nov 21, 2024

Conversation

SerifOZ
Copy link
Contributor

@SerifOZ SerifOZ commented Nov 18, 2024

Added __doc__ string documentation for vDate, vBoolean, vCalAddress, vDuration, vFloat, vGeo, vInt, vPeriod, vText, vTime, vUTCOffset and vUri.
Added vTime description, but examples from icalendar are not implemented because timezone support is not implemented.


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

@niccokunzmann
Copy link
Member

Oh. the tests are failing. Could you have a look? we also test docstrings with >>> with doctest

@niccokunzmann
Copy link
Member

thanks for the pr!

@SerifOZ
Copy link
Contributor Author

SerifOZ commented Nov 18, 2024

Oh. the tests are failing. Could you have a look? we also test docstrings with >>> with doctest

Okay, I am checking

@SerifOZ
Copy link
Contributor Author

SerifOZ commented Nov 18, 2024

  • Removed vText
  • Update vGeo and vPeriod examples

Can you check the updated __doc__ strings? I will edit if there is an error.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 11896048097

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.708%

Totals Coverage Status
Change from base Build 11876966775: 0.0%
Covered Lines: 4130
Relevant Lines: 4224

💛 - Coveralls

@niccokunzmann
Copy link
Member

Thanks! I love the documentation improvement!

Added vTime description, but examples from icalendar are not implemented because timezone support is not implemented.

Did you have a look at the build? It looks nice:
https://icalendar--745.org.readthedocs.build/en/745/api.html#icalendar.prop.vPeriod

If you find you want to polish anything, another PR is welcome!

@niccokunzmann niccokunzmann merged commit 32c5049 into collective:main Nov 21, 2024
18 checks passed
@niccokunzmann
Copy link
Member

niccokunzmann commented Nov 21, 2024

Can you check the updated doc strings? I will edit if there is an error.

I did not see an error. They look alright! I will check the boxes in the issue. #742

@niccokunzmann
Copy link
Member

I found an error when building the docs with tox -e docs

/home/nicco/icalendar/src/icalendar/prop.py:docstring of icalendar.prop.vDate:16: ERROR: Unexpected indentation.
/home/nicco/icalendar/src/icalendar/prop.py:docstring of icalendar.prop.vTime:48: WARNING: Block quote ends without a blank line; unexpected unindent.

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