You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "tisonkun (via GitHub)" <gi...@apache.org> on 2025/01/26 03:23:27 UTC
[PR] docs(bindings/java): better javadoc [opendal]
tisonkun opened a new pull request, #5572:
URL: https://github.com/apache/opendal/pull/5572
AS IS
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/java): better javadoc [opendal]
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on PR #5572:
URL: https://github.com/apache/opendal/pull/5572#issuecomment-2614193393
Preview:
<img width="1728" alt="image" src="https://github.com/user-attachments/assets/7c6dc76b-6d5a-4f16-b703-8c89828041c9" />
You can test locally with:
```
cd bindings/java
./mvnw site
./mvnw javadoc:javadoc
open target/site/apidocs/org/apache/opendal/ServiceConfig.Mysql.html
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/java): better javadoc [opendal]
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun commented on code in PR #5572:
URL: https://github.com/apache/opendal/pull/5572#discussion_r1929649920
##########
core/src/services/mysql/config.rs:
##########
@@ -26,11 +26,10 @@ use serde::Serialize;
#[serde(default)]
#[non_exhaustive]
pub struct MysqlConfig {
- /// 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
Review Comment:
Javadoc can hardly handle headings. Update the comment in an identical expressed way.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/java): better javadoc [opendal]
Posted by "codspeed-hq[bot] (via GitHub)" <gi...@apache.org>.
codspeed-hq[bot] commented on PR #5572:
URL: https://github.com/apache/opendal/pull/5572#issuecomment-2614194710
<!-- __CODSPEED_PERFORMANCE_REPORT_COMMENT__ -->
<!-- __CODSPEED_INSTRUMENTATION_PERFORMANCE_REPORT_COMMENT__ -->
## [CodSpeed Performance Report](https://codspeed.io/apache/opendal/branches/better-docs)
### Merging #5572 will **degrade performances by 18.88%**
<sub>Comparing <code>better-docs</code> (d34a03c) with <code>main</code> (1026d8a)</sub>
### Summary
`⚡ 4` improvements
`❌ 12` regressions
`✅ 57` untouched benchmarks
> :warning: _Please fix the performance issues or [acknowledge them on CodSpeed](https://codspeed.io/apache/opendal/branches/better-docs)._
### 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% |
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(bindings/java): better javadoc [opendal]
Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun merged PR #5572:
URL: https://github.com/apache/opendal/pull/5572
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org