From: John Mulligan <jmulligan@redhat.com>
Date: Tue, 19 Mar 2024 17:43:50 +0000 (-0400)
Subject: cephadm: add format-black reminder comment
X-Git-Tag: testing/wip-batrick-testing-20240411.154038~108^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=4e423259eadee61a897324ea2d3be6803f0506a1;p=ceph-ci.git

cephadm: add format-black reminder comment

Add a comment to tox.ini for people who might not know about the
relatively new `check-black` and `format-black` envs. While check-black
is part of the default envlist (as it is read-only) someone may not
know about the read-write version `format-black`.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
---

diff --git a/src/cephadm/tox.ini b/src/cephadm/tox.ini
index 106879b02f5..8ad1d297f38 100644
--- a/src/cephadm/tox.ini
+++ b/src/cephadm/tox.ini
@@ -5,6 +5,8 @@ envlist =
     check-black
     py3
 skipsdist = true
+# REMINDER: run `tox -e format-black` to apply black formatting
+# with the exact same specs as `check-black` expects.
 
 [flake8]
 max-line-length = 100