Skip to content

Comments

docs(bindings/java): better javadoc #5572

Merged
tisonkun merged 2 commits intomainfrom
better-docs
Jan 26, 2025
Merged

docs(bindings/java): better javadoc #5572
tisonkun merged 2 commits intomainfrom
better-docs

Conversation

@tisonkun
Copy link
Member

@tisonkun tisonkun commented Jan 26, 2025

AS IS

@tisonkun tisonkun requested a review from Xuanwo as a code owner January 26, 2025 03:23
@github-actions github-actions bot added the releases-note/docs The PR modifies docs related content or has a title that begins with "docs" label Jan 26, 2025
tisonkun
tisonkun commented Jan 26, 2025
View reviewed changes
core/src/services/mysql/config.rs
/// This connection string is used to connect to the mysql service. There are url based formats:
/// This connection string is used to connect to the mysql service. There are url based formats.
///
/// ## Url
Copy link
Member Author

@tisonkun tisonkun Jan 26, 2025

Choose a reason for hiding this comment

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

Javadoc can hardly handle headings. Update the comment in an identical expressed way.

@tisonkun
Copy link
Member Author

tisonkun commented Jan 26, 2025

Preview:

image

You can test locally with:

cd bindings/java
./mvnw site
./mvnw javadoc:javadoc
open target/site/apidocs/org/apache/opendal/ServiceConfig.Mysql.html

@codspeed-hq
Copy link

codspeed-hq bot commented Jan 26, 2025

CodSpeed Performance Report

Merging #5572 will degrade performances by 18.88%

Comparing better-docs (d34a03c) with main (1026d8a)

Summary

⚡ 4 improvements
❌ 12 regressions
✅ 57 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark BASE HEAD Change
❌ buffer 256 KiB * 32 chunk 125.3 ns 154.4 ns -18.88%
❌ buffer 256 KiB * 4 chunk 125.3 ns 154.4 ns -18.88%
❌ buffer 4.00 MiB * 32 chunk 125.3 ns 154.4 ns -18.88%
❌ buffer 4.00 MiB * 4 chunk 125.3 ns 154.4 ns -18.88%
⚡ bytes buf 256 KiB * 32 advance 464.2 ns 405.8 ns +14.37%
⚡ bytes buf 256 KiB * 4 advance 464.2 ns 405.8 ns +14.37%
⚡ bytes buf 4.00 MiB * 32 advance 464.2 ns 405.8 ns +14.37%
⚡ bytes buf 4.00 MiB * 4 advance 464.2 ns 405.8 ns +14.37%
❌ 256 KiB * 1000k chunk 125.3 ns 154.4 ns -18.88%
❌ 256 KiB * 1000k truncate 216.7 ns 245.8 ns -11.86%
❌ 256 KiB * 100k chunk 125.3 ns 154.4 ns -18.88%
❌ 256 KiB * 100k truncate 216.7 ns 245.8 ns -11.86%
❌ 256 KiB * 10k chunk 125.3 ns 154.4 ns -18.88%
❌ 256 KiB * 10k truncate 216.7 ns 245.8 ns -11.86%
❌ 256 KiB * 1k chunk 154.4 ns 183.6 ns -15.89%
❌ 256 KiB * 1k truncate 216.7 ns 245.8 ns -11.86%

@tisonkun tisonkun merged commit cdbcc0f into main Jan 26, 2025
279 of 280 checks passed
@tisonkun tisonkun deleted the better-docs branch January 26, 2025 04:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Xuanwo Xuanwo Xuanwo approved these changes

Assignees

No one assigned

Labels

releases-note/docs The PR modifies docs related content or has a title that begins with "docs"

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tisonkun @Xuanwo