Simulation-Software-Engineering / Simulation-Software-Engineering/Lecture-Material

Mention Ruff as a Python linter/formatter

Open
#219 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

lecture reworking part:building-packaging
Dominant language
Python
Stars
63
Forks
70
Avg merge
8d 18h
Merged PRs (30d)
1

Description

We currently mention Black as a formatter.
Some of the participants mentioned that they really liked Ruff as a linter and formatter.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the lecture material for the existing mention of Black and read that surrounding documentation first. Add Ruff as a linter and formatter, linking to the Ruff documentation, then verify the wording accurately distinguishes or groups it with Black.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.