docs(schemas): keep spec ids and em-dashes out of text a user reads - #528
Merged
Merged
Conversation
Schema property descriptions render as help text under form fields, so whatever is written there is product copy. Two things in it were not meant for a reader. Requirement ids: 8 strings carried a trailing "(REQ-DASH-011)" or similar. That is our traceability, and it means nothing to the person filling in the field. Em-dashes: 11 strings used one. Voice rule 8 bans them outright, so each is rewritten with a comma, a colon or a full stop rather than swapped for a different dash. One description also lost a paragraph explaining that a union type is rejected by the schema importer, and why that once prevented the schema being created. True, useful, and addressed to whoever maintains the register rather than to the person filling in the form. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
rubenvdlinde
requested review from
WilcoLouwerse,
bbrands02 and
rjzondervan
as code owners
September 3, 2026 09:44
Contributor
Quality Report — ConductionNL/launchpad @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| build | ✅ | ||||
| check-manifest | ✅ | ||||
| format | ✅ | ||||
| check-schema-l10n | ✅ | ||||
| composer | ✅ | ✅ 104/104 | |||
| npm | ✅ | ✅ 526/526 | |||
| app:check-code | ⏭️ | ||||
| info.xml | ✅ | ||||
| REUSE | ❌ | ||||
| PHPUnit | ✅ | ||||
| Newman | ✅ | ||||
| Playwright | ⏭️ deferred — runs on the promotion into beta/main, not on a pull request into development | ||||
| Hydra gates | ✅ |
Quality workflow — 2026-09-03 09:50 UTC
Download the full PDF report from the workflow artifacts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Schema property descriptions render as help text under form fields, so whatever is written there is product copy. Two things in it were not meant for a reader.
Requirement ids. 8 strings carried a trailing
(REQ-DASH-011)or similar. That is our traceability leaking onto a user's screen: it means nothing to the person filling in the field, and it costs the sentence its ending.Em-dashes. 11 strings used one. Voice rule 8 bans them outright, so each is rewritten with a comma, a colon or a full stop rather than swapped for a different dash.
After this, launchpad has 0 spec ids and 0 em-dashes in any
description/title/label/placeholder/helpvalue acrosslib/Settings/**andsrc/**.One description also loses a paragraph explaining that a union type such as
["string","null"]is rejected by the schema importer, and that this once silently prevented the schema being created. That is true and useful, and it is addressed to whoever maintains the register rather than to the person filling in the form.Edits are raw-text, so file formatting is untouched: 22 changed lines, not a reformat.
🤖 Generated with Claude Code