Skip to content

Document rumdl usage #363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnthagen merged 1 commit into from
Sep 27, 2026
Merged

Document rumdl usage #363

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ code. PEP 8 code compliance is verified using [Ruff][Ruff]. Ruff is configured i
Some code style settings are included in [`.editorconfig`](./.editorconfig) and will be configured
automatically in editors such as PyCharm.

Markdown files are linted with [rumdl][rumdl].

[rumdl]: https://rumdl.dev/

To lint code, run:

```shell
Expand All @@ -170,7 +174,9 @@ uv run nox -s lint_fix

### Automated Code Formatting

[Ruff][Ruff] is used to automatically format code and group and sort imports.
[Ruff][Ruff] is used to automatically format Python source files and group and sort imports.

Markdown files are formatted with [rumdl][rumdl].

To automatically format code, run:

Expand Down
Loading