From 5fed7f9bc728a809a6bf5f4f961a0567d6d33e25 Mon Sep 17 00:00:00 2001 From: Francesco Franchina Date: Sat, 16 Oct 2021 20:22:04 +0200 Subject: [PATCH] black, python: improved clarity of some statements --- pages/common/black.md | 6 +++--- pages/common/python.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/common/black.md b/pages/common/black.md index 899c66d08d..155062b7d4 100644 --- a/pages/common/black.md +++ b/pages/common/black.md @@ -9,13 +9,13 @@ - Format the code passed in as a string: -`black -c {{path/to/file_or_directory}}` +`black -c "{{code}}"` -- Output a diff for each file on stdout: +- Output the changes that would be applied for each file: `black --diff {{path/to/file_or_directory}}` -- Return the status without writing the files back: +- Check the need of auto-formatting without altering the files: `black --check {{path/to/file_or_directory}}` diff --git a/pages/common/python.md b/pages/common/python.md index f46dd64a1e..f8f9e2dab8 100644 --- a/pages/common/python.md +++ b/pages/common/python.md @@ -19,11 +19,11 @@ `python -c "{{expression}}"` -- Run library module as a script (terminates option list): +- Run the script of the specified library module: `python -m {{module}} {{arguments}}` -- Install a package using pip: +- Install a package using `pip`: `python -m pip install {{package_name}}`