Skip to content

Commit

Permalink
Merge pull request #746 from collective/prop-docstring
Browse files Browse the repository at this point in the history
Tidy up the docstring for ``icalendar.prop.vPeriod``
  • Loading branch information
niccokunzmann authored Nov 22, 2024
2 parents 345b96c + c41557d commit 590c4b6
Show file tree
Hide file tree
Showing 3 changed files with 464 additions and 338 deletions.
3 changes: 2 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Minor changes:
- Allow passing a ``datetime.date`` to ``TZP.localize_utc`` and ``TZP.localize`` methods.
- Document component classes with description from :rfc:`5545`.
- Merge "File Structure" and "Overview" sections in the docs. See `Issue 626 <https://github.com/collective/icalendar/issues/626>`_.
- Update code blocks in usage.rst with the correct lexer.
- Update code blocks in ``usage.rst`` with the correct lexer.
- Tidy up the docstring for ``icalendar.prop.vPeriod``.
- Improve typing and fix typing issues

Breaking changes:
Expand Down
2 changes: 2 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " livehtml to view a live preview of standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
Expand Down Expand Up @@ -163,6 +164,7 @@ doctest:

livehtml:
$(SPHINXAUTOBUILD) \
--watch ../src \
--ignore "*.swp" \
--port 8050 \
-b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
Expand Down
Loading

0 comments on commit 590c4b6

Please sign in to comment.