Skip to content

Commit

Permalink
doc: add skip bad events and fix testing title position
Browse files Browse the repository at this point in the history
  • Loading branch information
fabien-michel committed Apr 9, 2024
1 parent 17dec88 commit 2ecc6cd
Showing 1 changed file with 29 additions and 15 deletions.
44 changes: 29 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,17 @@ several times, it is faster to re-use the object coming from ``of()``.
events_of_day_3 = rcalendar.at(day_3)
# ...
Skip bad formatted ical events
******************************

Some events may be badly formatted and therefore cannot be handled by recurring-ical-events.
Passing ```skip_bad_events=True``` as ``of()`` argument will totally skip theses events.

.. code:: Python
of(a_calendar, skip_bad_events=True)
Version Fixing
**************

Expand Down Expand Up @@ -242,6 +253,24 @@ Please install `pre-commit <https://pre-commit.com/>`_ before git commit. It wi
pre-commit install
Testing
*******

This project's development is driven by tests.
Tests assure a consistent interface and less knowledge lost over time.
If you like to change the code, tests help that nothing breaks in the future.
They are required in that sense.
Example code and ics files can be transferred into tests and speed up fixing bugs.

You can view the tests in the `test folder
<https://github.com/niccokunzmann/python-recurring-ical-events/tree/master/test>`_.
If you have a calendar ICS file for which this library does not
generate the desired output, you can add it to the ``test/calendars``
folder and write tests for what you expect.
If you like, `open an issue <https://github.com/niccokunzmann/python-recurring-ical-events/issues>`_ first, e.g. to discuss the changes and
how to go about it.


To run the tests, we use ``tox``.
``tox`` tests all different Python versions which we want to be compatible to.

Expand All @@ -261,22 +290,7 @@ To run the tests in a specific Python version:
tox -e py39
Testing
*******
This project's development is driven by tests.
Tests assure a consistent interface and less knowledge lost over time.
If you like to change the code, tests help that nothing breaks in the future.
They are required in that sense.
Example code and ics files can be transferred into tests and speed up fixing bugs.

You can view the tests in the `test folder
<https://github.com/niccokunzmann/python-recurring-ical-events/tree/master/test>`_.
If you have a calendar ICS file for which this library does not
generate the desired output, you can add it to the ``test/calendars``
folder and write tests for what you expect.
If you like, `open an issue <https://github.com/niccokunzmann/python-recurring-ical-events/issues>`_ first, e.g. to discuss the changes and
how to go about it.
New Releases
------------
Expand Down

0 comments on commit 2ecc6cd

Please sign in to comment.