Skip to content

remove commented out link - #12637

Merged
elharo merged 4 commits into
masterfrom
pr-9
Jul 31, 2026
Merged

remove commented out link#12637
elharo merged 4 commits into
masterfrom
pr-9

Conversation

@elharo

@elharo elharo commented Jul 30, 2026

Copy link
Copy Markdown
Contributor
  • Updates the FAQ comment to explain Why it's commented out

Fixes #9.

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of observations on this one-line change:

  1. The <!--item name="FAQ" href="faq.html"/--> line has been commented out since June 2011 (commit 799d63b by Hervé Boutemy). After 15+ years of dormancy, removing the dead line entirely would be a cleaner approach than annotating it with a second comment — the existing XML is already self-documenting.

  2. The PR body references "Fixes #9" but PR/issue #9 is "[MNG-5513] Artifact filtering not updated for Eclipse Aether filtering" — an unrelated, already-merged change. This reference should be removed.

The change itself is harmless, but adding a comment to 15-year-old dead code is debatable when deletion would be simpler.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

@elharo elharo changed the title docs: clarify commented FAQ link status with comment remove commented out link Jul 30, 2026
@elharo elharo added the documentation Improvements or additions to documentation label Jul 30, 2026

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The author addressed our previous feedback — the dead commented-out FAQ link (dormant since 2011) is now removed entirely rather than annotated. Clean improvement.

Minor nit (non-blocking): The removal replaces the commented-out line with a blank line containing trailing whitespace. Ideally squash that blank line out entirely for a cleaner diff.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-reviewed after the new commit (360425d0 — Remove blank line in site.xml menu section). The change is a clean whitespace cleanup removing the blank line left behind after deleting the commented-out FAQ link. No issues — still looks good.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of gnodet

@elharo
elharo merged commit 3e01a12 into master Jul 31, 2026
23 checks passed
@elharo
elharo deleted the pr-9 branch July 31, 2026 12:00
@github-actions github-actions Bot added this to the 4.1.0 milestone Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants