Skip to content

Fix gossipTimeout documentation#385

Open
w1am wants to merge 1 commit intotrunkfrom
fix/gossip-timeout-docs
Open

Fix gossipTimeout documentation#385
w1am wants to merge 1 commit intotrunkfrom
fix/gossip-timeout-docs

Conversation

@w1am
Copy link
Copy Markdown
Contributor

@w1am w1am commented Apr 14, 2026

The gossipTimeout documentation had incorrect default values and units. The markdown docs stated the default as 5 seconds and the Javadoc listed it as 3, but the actual code default in ConnectionSettingsBuilder is 3000 milliseconds. Both locations have been updated to reflect the correct value and unit.

The documentation stated the default as 5 seconds, and the Javadoc
listed it as 3. The actual code default is 3000 milliseconds. Updated
both locations to reflect the correct value and unit.
@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Fix gossipTimeout documentation default value and unit

📝 Documentation

Grey Divider

Walkthroughs

Description
• Fix gossipTimeout default value from 3 to 3000
• Correct unit from seconds to milliseconds
• Update both Javadoc and markdown documentation
Diagram
flowchart LR
  A["gossipTimeout docs<br/>incorrect values"] -- "update to 3000ms" --> B["gossipTimeout docs<br/>correct values"]
  A -- "Javadoc: 3 → 3000" --> B
  A -- "Markdown: 5s → 3000ms" --> B
Loading

Grey Divider

File Changes

1. src/main/java/io/kurrent/dbclient/KurrentDBClientSettings.java 📝 Documentation +1/-1

Update gossipTimeout Javadoc default value

• Updated Javadoc default value for gossipTimeout from 3 to 3000
• Clarified unit is milliseconds in class-level documentation

src/main/java/io/kurrent/dbclient/KurrentDBClientSettings.java


2. docs/api/getting-started.md 📝 Documentation +1/-1

Correct gossipTimeout default and unit in docs

• Changed gossipTimeout default value from 5 to 3000 in parameter table
• Updated unit description from seconds to milliseconds

docs/api/getting-started.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

Code Review by Qodo

Grey Divider

Looking for bugs?

Check back in a few minutes. An AI review agent is analyzing this pull request.

Grey Divider

Qodo Logo

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant