Clarify check argument is needed for github action workflow

[jlplenio]

Description

I used the Black github action workflow in one of my projects and passed arguments via options. Because I had initially omitted '--check', my workflow did not fail, although Black found files that needed formatting. I would like to suggest this one sentence that makes that even clearer. It would have saved me some debugging time, as I am quite new to GitHub action workflows.

Clarifies that the check argument is required so that the workflow fails when Black finds files that need to be formatted based on the correct exit codes.

I have successfully run the docs build test locally.

Checklist - did you ...

• Add an entry in CHANGES.md if necessary?
• Add / update tests if necessary?
• Add new / update outdated documentation?

[cooperlees]

I agree and approve this extra addition. I feel it's too late now, but we should have probably defaulted with --check.

Should we think about a Major version release changing this default in the future? What are the downsides people see other than helping people find unformatted files?

[cooperlees]

Let's just please our prettier formatter on this markdown file please.

[jlplenio]

I was unable to reproduce the prettier error on my WSL. He somehow does not care about line length.
I used the suggested edit from the failed pre-commit workflow.

[ichard26]

I'm okay with adding --check to the argument list unconditionally starting with 23.0.0.

Change applied!

[felix-hilden]

LGTM and a forced --check sounds good @ichard26 👍