issue-742

[SerifOZ]

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]

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

[niccokunzmann]

thanks for the pr!

[SerifOZ]

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

Okay, I am checking

[SerifOZ]

• Removed vText
• Update vGeo and vPeriod examples

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

[coveralls]

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
Change from base Build 11876966775:	0.0%
Covered Lines:	4130
Relevant Lines:	4224

---

💛 - Coveralls

[niccokunzmann]

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]

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]

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.

[stevepiercy]

First which docstring format should we use?

https://stackoverflow.com/a/24385103/2214933

I prefer Google style for its simplicity and adaptability.

Right now the docstrings don't render well.

https://icalendar.readthedocs.io/en/latest/ api.html#icalendar.prop.vBoolean

[niccokunzmann]

I think a docstring style discussion is worth its own issue! Could you open it?