Skip to content

docs: escape reconnect listener javadoc comparator - #132

Open
GregHolmes wants to merge 1 commit into
mainfrom
gh/fix-reconnecting-websocket-javadoc
Open

GregHolmes wants to merge 1 commit into
mainfrom
gh/fix-reconnecting-websocket-javadoc

Conversation

@GregHolmes

@GregHolmes GregHolmes commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Escapes the minReconnectionDelayMs <= maxReconnectionDelayMs comparator in the frozen ReconnectingWebSocketListener Javadoc so the generated documentation parses correctly.
  • Documents the retained patch in .fernignore and AGENTS.md.
  • Rebases the branch onto the latest main.

Validation

  • ./gradlew javadoc
  • git diff --check

@dg-coreylweathers dg-coreylweathers changed the title fix: escape reconnect listener javadoc comparator docs: escape reconnect listener javadoc comparator Oct 23, 2026

@dg-coreylweathers dg-coreylweathers 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.

Approving. Verified in Docker (eclipse-temurin:17-jdk): ./gradlew javadoc on main exits 1 with exactly one error, ReconnectingWebSocketListener.java:588: error: malformed HTML; on this branch it exits 0 with no errors. spotlessCheck compileJava compileExamples unitTest also passes here (148 tests), so the Spotless note in the description looks like a local mount artifact rather than a repo problem; worth dropping that sentence.

The published Javadoc jar was never affected (the Maven release profile runs javadoc with doclint none), so this is contributor-facing only. The file is already in .fernignore, so the next regen keeps the fix.

Retitled to docs: so release-please does not cut a comment-only 0.11.2; the change ships with the next real release.

This conflicts with #131 on adjacent AGENTS.md bullets; merging this first and rebasing #131 is the easy order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants