collective / icalendar

icalendar parser library for Python
https://icalendar.readthedocs.io
Other
1k stars 171 forks source link

Tidy up the docstring for ``icalendar.prop.vPeriod`` #746

Closed stevepiercy closed 3 days ago

stevepiercy commented 4 days ago

See preview:

https://icalendar--746.org.readthedocs.build/en/746/api.html#icalendar.prop.vPeriod


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

coveralls commented 4 days ago

Pull Request Test Coverage Report for Build 11972144061

Details


Totals Coverage Status
Change from base Build 11971956834: 0.0%
Covered Lines: 4538
Relevant Lines: 4715

💛 - Coveralls
stevepiercy commented 4 days ago

I just reformatted all the docstrings. It was a total mess. Now it is legible as HTML.

However, we should consider adopting a docstring standard, and document that adoption. I recommend Google docstring, as describe in this post:

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

niccokunzmann commented 3 days ago

Hi that looks good!