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-release.git
The following commit(s) were added to refs/heads/main by this push:
new 16ba903 Ensure that buttons and labels are consistently in sentence
case
16ba903 is described below
commit 16ba903e65251810c1a63b87ce29bd698f76db9c
Author: Sean B. Palmer <[email protected]>
AuthorDate: Wed Apr 2 14:09:29 2025 +0100
Ensure that buttons and labels are consistently in sentence case
---
atr/blueprints/admin/templates/delete-release.html | 2 +-
atr/blueprints/admin/templates/update-committees.html | 2 +-
atr/routes/draft.py | 2 +-
atr/templates/keys-add.html | 4 ++--
atr/templates/release-vote.html | 4 ++--
docs/conventions.html | 4 ++--
docs/conventions.md | 4 ++--
7 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/atr/blueprints/admin/templates/delete-release.html
b/atr/blueprints/admin/templates/delete-release.html
index 9116c64..2c38f2a 100644
--- a/atr/blueprints/admin/templates/delete-release.html
+++ b/atr/blueprints/admin/templates/delete-release.html
@@ -19,7 +19,7 @@
{{ form.csrf_token }}
<div class="mb-3">
- <label class="form-label">Select Release(s) to Delete:</label>
+ <label class="form-label">Select releases to delete:</label>
{% if releases %}
<div class="list-group overflow-y-auto border rounded">
{% for release in releases %}
diff --git a/atr/blueprints/admin/templates/update-committees.html
b/atr/blueprints/admin/templates/update-committees.html
index 3041b65..ade44ee 100644
--- a/atr/blueprints/admin/templates/update-committees.html
+++ b/atr/blueprints/admin/templates/update-committees.html
@@ -91,7 +91,7 @@
<div id="status"></div>
<form action="javascript:submitForm().then(_ => { return false; })">
- <button type="submit" id="submitButton">Update Projects</button>
+ <button type="submit" id="submitButton">Update projects</button>
</form>
<script>
diff --git a/atr/routes/draft.py b/atr/routes/draft.py
index e845f7b..f708e2c 100644
--- a/atr/routes/draft.py
+++ b/atr/routes/draft.py
@@ -150,7 +150,7 @@ async def add_file(session: routes.CommitterSession,
project_name: str, version_
file_data = wtforms.MultipleFileField(
"File(s)", validators=[wtforms.validators.InputRequired("File(s)
are required")]
)
- submit = wtforms.SubmitField("Add file(s)")
+ submit = wtforms.SubmitField("Add file or files")
def validate_file_name(self, field: wtforms.Field) -> bool:
if field.data and len(self.file_data.data) > 1:
diff --git a/atr/templates/keys-add.html b/atr/templates/keys-add.html
index d035e93..5df0843 100644
--- a/atr/templates/keys-add.html
+++ b/atr/templates/keys-add.html
@@ -54,7 +54,7 @@
<form method="post" class="striking">
<div class="mb-4">
<div class="mb-3">
- <label for="public_key" class="form-label">Public Key:</label>
+ <label for="public_key" class="form-label">Public key:</label>
</div>
<textarea id="public_key"
name="public_key"
@@ -93,6 +93,6 @@
</div>
{% endif %}
- <button type="submit" class="btn btn-primary">Add Key</button>
+ <button type="submit" class="btn btn-primary">Add key</button>
</form>
{% endblock content %}
diff --git a/atr/templates/release-vote.html b/atr/templates/release-vote.html
index 54c224d..4afbeb8 100644
--- a/atr/templates/release-vote.html
+++ b/atr/templates/release-vote.html
@@ -99,12 +99,12 @@
</div>
<div class="mb-4">
- <label class="fw-medium mb-2">Email Preview:</label>
+ <label class="fw-medium mb-2">Email preview:</label>
<pre class="p-3 bg-white border rounded font-monospace
overflow-auto">{{ email_preview }}</pre>
</div>
<div class="mt-4">
- <button type="submit" class="btn btn-primary">Prepare Vote
Email</button>
+ <button type="submit" class="btn btn-primary">Prepare vote
email</button>
<a href="{{ as_url(routes.candidate.vote) }}"
class="btn btn-link text-secondary">Cancel</a>
</div>
diff --git a/docs/conventions.html b/docs/conventions.html
index 7c2588d..ea4f4dc 100644
--- a/docs/conventions.html
+++ b/docs/conventions.html
@@ -153,7 +153,7 @@ def _verify_archive_integrity_do_something():
<h3>Use terse comments on their own lines</h3>
<p>Place comments on dedicated lines preceding the relevant code block.
Comments at the ends of lines are strictly reserved for linter or type checker
directives. This convention enhances code scannability for such directives.
General comments must not appear at the end of code lines. Keep comments
concise, using sentence case without terminal punctuation. Each sentence
forming a comment must occupy its own line.</p>
<h2>HTML</h2>
-<h3>Use sentence case for headings</h3>
-<p>We write headings like "This is a heading", and not "This is
a Heading" or "This Is A Heading". This follows the <a
href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Section_headings";>Wikipedia
style for headings</a>. The same goes for button texts.</p>
+<h3>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>
<h3>Use Bootstrap classes for all style</h3>
<p>We use Bootstrap classes for style, and avoid custom classes unless
absolutely necessary. If you think that you have to resort to a custom class,
consult the list of <a href="https://bootstrapclasses.com/";>Bootstrap
classes</a> for guidance. There is usually a class for what you want to
achieve, and if there isn't then you may be making things too complicated.
Complicated, custom style is difficult for a team to maintain. If you still
believe that a new class is strictly warranted, th [...]
diff --git a/docs/conventions.md b/docs/conventions.md
index 67feb2f..035b568 100644
--- a/docs/conventions.md
+++ b/docs/conventions.md
@@ -244,9 +244,9 @@ Place comments on dedicated lines preceding the relevant
code block. Comments at
## HTML
-### Use sentence case for headings
+### Use sentence case for headings, form labels, and submission buttons
-We write headings like "This is a heading", and not "This is a Heading" or
"This Is A Heading". This follows the [Wikipedia style for
headings](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Section_headings).
The same goes for button texts.
+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 [Wikipedia style for
headings](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Section_headings).
### Use Bootstrap classes for all style
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
