Skip to content

Commit

Permalink
do not use mdformatter
Browse files Browse the repository at this point in the history
  • Loading branch information
PythonFZ committed Feb 1, 2025
1 parent 62a3e5d commit 0cc27e9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
10 changes: 5 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 0cc27e9

Please sign in to comment.