Skip to content

Fix documentation for client-thrift and client-retry #6195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 9, 2025
Merged

Fix documentation for client-thrift and client-retry #6195

merged 1 commit into from
Apr 9, 2025

Conversation

pppurple
Copy link
Contributor

@pppurple pppurple commented Apr 8, 2025

Motivation:

I found an incorrect class name and the use of deprecated functions in the document.
Therefore I fixed it to use the recommended function instead.

Modifications:

  • Change ThriftClient to ThriftClients
  • Use RetryConfig instead of deprecated functions.

Result:

  • The corrected document will be displayed.

@CLAassistant
Copy link

CLAassistant commented Apr 8, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

pppurple
pppurple commented Apr 8, 2025
View reviewed changes
site/src/pages/docs/client-retry.mdx
@@ -221,7 +221,10 @@ the maximum number of total attempts to 10 by default. You can change this value
`maxTotalAttempts` when you build a <type://RetryingClient>:

```java
RetryingClient.newDecorator(rule, maxTotalAttempts);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The deprecated spec is as follows.
https://javadoc.io/static/com.linecorp.armeria/armeria-javadoc/1.32.3/com/linecorp/armeria/client/retry/RetryingClient.html#newDecorator(com.linecorp.armeria.client.retry.RetryRule,int)

pppurple
pppurple commented Apr 8, 2025
View reviewed changes
site/src/pages/docs/client-retry.mdx
@@ -246,8 +249,11 @@ Second, it occurs when the time of individual attempt in retry has passed the ti
You can configure it when you create the decorator:

```java
RetryingClient.newDecorator(rule, maxTotalAttempts,
responseTimeoutMillisForEachAttempt);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The deprecated spec is as follows.
https://javadoc.io/static/com.linecorp.armeria/armeria-javadoc/1.32.3/com/linecorp/armeria/client/retry/RetryingClient.html#newDecorator(com.linecorp.armeria.client.retry.RetryRule,int,long)

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 8, 2025

🔍 Build Scan® (commit: 866d479)

Job name Status Build Scan®
build-ubicloud-standard-16-jdk-8 ✅ https://ge.armeria.dev/s/cmfpfful4gyki
build-ubicloud-standard-16-jdk-21-snapshot-blockhound ✅ https://ge.armeria.dev/s/ahhsampsltkrk
build-ubicloud-standard-16-jdk-17-min-java-17-coverage ✅ https://ge.armeria.dev/s/uuqkyqewgbi64
build-ubicloud-standard-16-jdk-17-min-java-11 ✅ https://ge.armeria.dev/s/eph5juxw7bxgc
build-ubicloud-standard-16-jdk-17-leak ✅ https://ge.armeria.dev/s/2j7apj2bpkz46
build-ubicloud-standard-16-jdk-11 ✅ https://ge.armeria.dev/s/b6yf5eckxuvhs
build-macos-latest-jdk-21 ✅ https://ge.armeria.dev/s/xov2or5h3wjbw

ikhoon
ikhoon approved these changes Apr 8, 2025
View reviewed changes
Copy link
Contributor

@ikhoon ikhoon left a comment

Choose a reason for hiding this comment

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

Thanks, @pppurple!

@ikhoon ikhoon added the cleanup label Apr 8, 2025
@ikhoon ikhoon added this to the 1.33.0 milestone Apr 8, 2025
trustin
trustin approved these changes Apr 9, 2025
View reviewed changes
Copy link
Member

@trustin trustin left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the fixes, @pppurple! 🙏

minwoox
minwoox approved these changes Apr 9, 2025
View reviewed changes
Copy link
Contributor

@minwoox minwoox left a comment

Choose a reason for hiding this comment

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

Thanks!

@trustin trustin merged commit 4c2c257 into line:main Apr 9, 2025
14 checks passed
@trustin trustin changed the title fix documents for client-thrift and client-entry Fix documentation for client-thrift and client-retry Apr 9, 2025
@pppurple pppurple deleted the fix-documents branch April 9, 2025 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trustin trustin trustin approved these changes

@ikhoon ikhoon ikhoon approved these changes

@jrhee17 jrhee17 jrhee17 approved these changes

@minwoox minwoox minwoox approved these changes

Assignees
No one assigned
Labels
cleanup
Projects
None yet
Milestone
1.33.0
Development

Successfully merging this pull request may close these issues.
6 participants
@pppurple @CLAassistant @trustin @ikhoon @jrhee17 @minwoox