From 0cc27e975f87799f346576ffbfdc0d008b9b5a04 Mon Sep 17 00:00:00 2001 From: Fabian Zills Date: Sat, 1 Feb 2025 16:26:41 +0100 Subject: [PATCH] do not use mdformatter --- .pre-commit-config.yaml | 10 +++++----- README.md | 9 ++++++--- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f28c3e09..b7679253 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -31,8 +31,8 @@ repos: hooks: - id: ruff args: ['--fix'] - - repo: https://github.com/executablebooks/mdformat - rev: 0.7.22 - hooks: - - id: mdformat - args: ["--wrap=80"] + # - repo: https://github.com/executablebooks/mdformat + # rev: 0.7.22 + # hooks: + # - id: mdformat + # args: ["--wrap=80"] diff --git a/README.md b/README.md index f910ecb8..8ad74079 100644 --- a/README.md +++ b/README.md @@ -85,11 +85,13 @@ In ZnTrack, each **Node** is defined as a Python class. The class attributes define the **inputs** (parameters and dependencies) and **outputs**, while the `run` method contains the computational logic to be executed. -> [!NOTE] ZnTrack uses Python dataclasses under the hood, providing an automatic +> [!NOTE] +> ZnTrack uses Python dataclasses under the hood, providing an automatic > `__init__` method. Starting from Python 3.11, most IDEs should reliably > provide type hints for ZnTrack Nodes. -> [!TIP] For files produced during the `run` method, ZnTrack provides a unique +> [!TIP] +> For files produced during the `run` method, ZnTrack provides a unique > **Node Working Directory** (`zntrack.nwd`). Always use this directory to store > files to ensure reproducibility and avoid conflicts. @@ -204,7 +206,8 @@ workflow. Follow these steps: project.repro() ``` - > [!TIP] If you don’t want to execute the graph immediately, use + > [!TIP] + > If you don’t want to execute the graph immediately, use > `project.build()` instead. You can run the graph later using `dvc repro` or > the [paraffin](https://github.com/zincware/paraffin) package.