slachiewicz commented on PR #1639:
URL: https://github.com/apache/maven-site/pull/1639#issuecomment-5232214990

   Thanks for the review — all five comments are addressed in the latest commit.
   
   The one about the plugin site was the important one, and you were right. I 
checked the history before changing it: **no Maven plugin retirement has ever 
removed a live site page.** All twelve retired plugins still have their 
directory under `website/components/plugins/` and all twelve return HTTP 200, 
going back to `maven-one-plugin` and `maven-idea-plugin` in 2013. 
`plugins-archives/` (539 directories) is filled by the *release* process, one 
per released version, so nothing "moves" at retirement time. I had written the 
guidance on the opposite assumption. It now says to leave `.asf.yaml` 
`homepage` pointing at the plugin site, and the README step keeps a link to it.
   
   Also split the three run-on sentences and added the missing comma.
   
   ## On long lines — findings, and a question
   
   You mentioned long lines make small suggestions hard. That is worth fixing, 
but I do not think tooling can do it. What I found:
   
   **Spotless does not touch Markdown here at all.** `maven-parent` 49 
configures only `<java>` and `<pom>`; this repo's own `<markdown><flexmark/>` 
block is commented out in `pom.xml`, citing #1395 (YAML front matter 
destroyed). That issue is closed, and current Spotless has a `YamlFrontMatter` 
extension, so the comment looks stale — re-enabling is probably possible now.
   
   **The result is no convention at all.** Across the 248 files in 
`content/markdown`:
   
   | | |
   |---|---|
   | average non-empty line | 65 chars |
   | lines over 120 chars | 2959 |
   | lines over 200 chars | 1344 |
   | longest line | 1368 chars |
   
   **The catch.** Spotless can enforce a width, via 
`<formatterOptions><rightMargin>120</rightMargin></formatterOptions>` — but 
`rightMargin` *reflows to fill* the margin. That makes it actively hostile to 
the thing that would actually help review: one sentence per line. Change a 
sentence, get a one-line diff, and your "propose changes" button works on it 
alone. Column wrapping does the reverse — fix one word mid-paragraph and 
everything after it reflows, so a typo shows up as a five-line diff.
   
   So the two options are mutually exclusive, and no formatter can express "one 
sentence per line":
   
   1. **Semantic line breaks as a convention**, applied only to text someone is 
already editing. No tooling, no mass reflow, no `git blame` damage.
   2. **Enable Spotless with `rightMargin`**, mechanically enforced, at the 
cost of one 248-file reformat and giving up per-sentence diffs.
   
   I lean towards 1, but you have reviewed far more of this repo than I have — 
which would you rather have? Happy to write it up as a short contributor-docs 
section and reflow Step 3 here as the worked example, in a separate PR so the 
guideline can be judged on its own.
   
   <sub>Drafted with Claude — please verify</sub>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to