From 0a21d64effb6c32ed98f6cf4be4c0c5cdc875335 Mon Sep 17 00:00:00 2001 From: thc1006 <84045975+thc1006@users.noreply.github.com> Date: Sun, 9 Aug 2026 02:14:05 +0800 Subject: [PATCH] Bring master's README in line with develop's `Ruff (format)` fails on master, and any pull request into master shows a red `lint (3.10)` for a reason unrelated to it. The file is README.md. The linters job installs ruff unpinned. Recent versions format Python code blocks inside Markdown, which they did not use to, so the quickstart snippets now differ from what the formatter produces: single quotes in one call, a call split across three lines that fits on one, and two blocks indented two spaces rather than four. Taken from develop rather than by running the formatter here. develop is already formatted this way, and its README and master's differ by exactly this change, so copying it leaves the two identical and removes the conflict the next release sync would otherwise carry. Verified byte for byte. Whitespace and quotes only; no snippet behaves differently when run. This does not stop it recurring. The job takes whatever ruff is newest, so the next widening of the formatter's scope lands the same way. Pinning it would be the fix for that, and is a separate change. Signed-off-by: thc1006 <84045975+thc1006@users.noreply.github.com> --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8315dd78d..eff904d11 100644 --- a/README.md +++ b/README.md @@ -170,10 +170,10 @@ env = Environment( tomorrow = datetime.date.today() + datetime.timedelta(days=1) env.set_date( - (tomorrow.year, tomorrow.month, tomorrow.day, 12), timezone="America/Denver" -) # Tomorrow's date in year, month, day, hour UTC format + (tomorrow.year, tomorrow.month, tomorrow.day, 12), timezone="America/Denver" +) # Tomorrow's date in year, month, day, hour UTC format -env.set_atmospheric_model(type='Forecast', file='GFS') +env.set_atmospheric_model(type="Forecast", file="GFS") ``` This can be followed up by starting a Solid Motor object. To get help on it, just use: @@ -233,9 +233,7 @@ buttons = calisto.set_rail_buttons( calisto.add_motor(Pro75M1670, position=-1.255) -nose = calisto.add_nose( - length=0.55829, kind="vonKarman", position=1.278 -) +nose = calisto.add_nose(length=0.55829, kind="vonKarman", position=1.278) fins = calisto.add_trapezoidal_fins( n=4, @@ -290,7 +288,7 @@ To actually create a Flight object, use: ```python test_flight = Flight( - rocket=calisto, environment=env, rail_length=5.2, inclination=85, heading=0 + rocket=calisto, environment=env, rail_length=5.2, inclination=85, heading=0 ) ```