This is an automated email from the ASF dual-hosted git repository. sbp pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/tooling-trusted-releases.git
commit e629f26ce382bf6d173e0a790209cab685f8e429 Author: Dave Fisher <[email protected]> AuthorDate: Mon Nov 24 10:56:34 2025 -0800 Add note about f-string code convention --- atr/docs/code-conventions.html | 1 + atr/docs/code-conventions.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/atr/docs/code-conventions.html b/atr/docs/code-conventions.html index d77482b..cdd051a 100644 --- a/atr/docs/code-conventions.html +++ b/atr/docs/code-conventions.html @@ -167,6 +167,7 @@ if a or b: <p>Using <code>case _</code> breaks type checking in such situations.</p> <h3 id="use-f-string-interpolation-instead-of-printf-style-formatting">Use f-string interpolation instead of printf style formatting</h3> <p>This should be adhered to even in contexts where printf style is usually expected, such as in <code>log.info</code> calls, unless there is a reason not to, such as when there are specific printf style flags which have no f-string equivalent.</p> +<p>This convention is not enforced by any checks. Enforcement is via code review. See <a href="https://github.com/apache/tooling-trusted-releases/issues/339";>issue #339</a> for a discussion.</p> <h2 id="html">HTML</h2> <h3 id="use-sentence-case-for-headings-form-labels-and-submission-buttons">Use sentence case for headings, form labels, and submission buttons</h3> <p>We write headings, form labels, and submission buttons in the form "This is some text", and not "This is Some Text" or "This Is Some Text". This follows the <a href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Section_headings";>Wikipedia style for headings</a>.</p> diff --git a/atr/docs/code-conventions.md b/atr/docs/code-conventions.md index 4bd987b..f39e79a 100644 --- a/atr/docs/code-conventions.md +++ b/atr/docs/code-conventions.md @@ -251,6 +251,8 @@ Using `case _` breaks type checking in such situations. This should be adhered to even in contexts where printf style is usually expected, such as in `log.info` calls, unless there is a reason not to, such as when there are specific printf style flags which have no f-string equivalent. +This convention is not enforced by any checks. Enforcement is via code review. See [issue #339](https://github.com/apache/tooling-trusted-releases/issues/339) for a discussion. + ## HTML ### Use sentence case for headings, form labels, and submission buttons --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
