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
The following commit(s) were added to refs/heads/main by this push:
new 7db1ab9 Rebuild the documentation
7db1ab9 is described below
commit 7db1ab945079521a577d89ca0f4dbcf2ed83cf89
Author: Sean B. Palmer <[email protected]>
AuthorDate: Mon Nov 24 19:03:25 2025 +0000
Rebuild the documentation
---
atr/docs/code-conventions.html | 1 +
atr/docs/code-conventions.md | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
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 edae328..f39e79a 100644
--- a/atr/docs/code-conventions.md
+++ b/atr/docs/code-conventions.md
@@ -251,7 +251,7 @@ 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.
-> While this choice appears arbitrary it is a preference which 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.
+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
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
