Skip to content

docs: clarify new() docstrings of Alarm, Availability, Available and Todo #5054

docs: clarify new() docstrings of Alarm, Availability, Available and Todo

docs: clarify new() docstrings of Alarm, Availability, Available and Todo #5054

Workflow file for this run

name: Check code style with ruff
on: [push, pull_request]
jobs:
ruff:
runs-on: ubuntu-latest
env:
MESSAGE: |
Your code is not formatted!
Please set up your development environment and run the formatting command.
https://icalendar.readthedocs.io/en/stable/contribute/development.html#code-format
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
- name: Set up Python
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7
with:
python-version: 3.14
cache: pip
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install . --group formatting
sudo apt install -y git-delta
- name: Run the ruff formatter to change files
run: ruff format .
- name: Fail if we detect any changes on the file system
run: |
git diff | delta --light --keep-plus-minus-markers
if ! git diff --exit-code --quiet; then
echo "$MESSAGE"
exit 1;
fi
env:
FORCE_COLOR: '1'
- name: Run ruff checks on the files
run: |
if ! ruff check; then
echo "$MESSAGE"
exit 1;
fi