From: Kienan Stewart <kstewart@efficios.com>
Date: Mon, 12 Feb 2024 21:00:42 +0000 (-0500)
Subject: docs: coding style: Add usage of black for formatting python code
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=cd96f17f874d69f79b487dbf6c84257e44be9043;p=lttng-tools.git

docs: coding style: Add usage of black for formatting python code

Change-Id: I73131b9cae9de05be0e85d197edb1976b762402e
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/CodingStyle.md b/CodingStyle.md
index 3074ea883..b1f5be1dd 100644
--- a/CodingStyle.md
+++ b/CodingStyle.md
@@ -263,6 +263,10 @@ Here are a couple of reminders:
 
 * Accept a by-value parameter and move it (when it's moveable) when you intend to copy it anyway. You can do this with most STL containers.
 
+## Python
+
+Python code should be formatted using [black](https://github.com/psf/black).
+
 ## C Style (historical)
 
 The coding style used for this project follows the the Linux kernel guide lines, except that brackets `{`, `}` should typically be used even for single-line if/else statements. Please refer to: