You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@texera.apache.org by "Yicong-Huang (via GitHub)" <gi...@apache.org> on 2026/05/02 08:47:54 UTC

[PR] docs(scala): fully-qualify ScalaDoc @throws and link references [texera]

Yicong-Huang opened a new pull request, #4671:
URL: https://github.com/apache/texera/pull/4671

   ### What changes were proposed in this PR?
   
   Resolve the ScalaDoc broken-link warnings tracked in #4670 by replacing bare class names with fully-qualified names in `@throws` tags and `[[X]]` inline links.
   
   - JDK exception references → `java.lang.AssertionError`, `java.util.NoSuchElementException`, `java.lang.IllegalArgumentException`, `java.io.FileNotFoundException`, `java.lang.Exception`, `java.sql.SQLException`, `java.lang.reflect.AnnotatedType`.
   - JAX-RS exception → `javax.ws.rs.BadRequestException`.
   - Project-internal references resolved against their companion objects: `org.apache.texera.amber.core.tuple.AttributeTypeUtils.AttributeTypeException`, `org.apache.texera.service.resource.ComputingUnitManagingResource.DashboardWorkflowComputingUnit`.
   - `S3StorageClient.scala` — Javadoc `{@link software.amazon.awssdk...}` references converted to ScalaDoc `[[software.amazon.awssdk...]]` form (the AWS SDK references are already on the classpath; ScalaDoc was rejecting the Javadoc syntax).
   - Vendored `JsonSchemaInject.java` — same-class method links `{@link #json()}` rewritten with explicit class context as `{@link JsonSchemaInject#json()}`.
   
   `@throws[X]` annotations in code (Scala-level annotations, not docstring tags) are intentionally untouched — only the ScalaDoc `* @throws X` lines and `[[X]]` references in comments change.
   
   Two extra docstring sites were swept up while at it (`StableMergeSortOpExecSpec.scala`, `DatasetResource.scala`) so the build does not start emitting new warnings the next time their modules' scaladoc runs.
   
   ### Any related issues, documentation, discussions?
   
   Closes #4670.
   
   ### How was this PR tested?
   
   Pure ScalaDoc / comment changes — no behavioral effect, no test changes. Verified by:
   
   1. \`grep -r '@throws AssertionError' --include='*.scala'\` and the same for the other 8 bare class names returns zero hits across the repo.
   2. CI's scala job runs scaladoc as part of \`sbt jacoco\` / compile and will report any remaining unresolved references.
   
   ### Was this PR authored or co-authored using generative AI tooling?
   
   Generated-by: Claude Code (Opus 4.7, 1M context)


-- 
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: notifications-unsubscribe@texera.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(scala): fully-qualify ScalaDoc @throws and link references [texera]

Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #4671:
URL: https://github.com/apache/texera/pull/4671#issuecomment-4363444130

   ## [Codecov](https://app.codecov.io/gh/apache/texera/pull/4671?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
   :white_check_mark: All modified and coverable lines are covered by tests.
   :white_check_mark: Project coverage is 85.05%. Comparing base ([`1780287`](https://app.codecov.io/gh/apache/texera/commit/1780287a6f5bfa3243cd0c192b1c933c3b834ca9?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`73cd134`](https://app.codecov.io/gh/apache/texera/commit/73cd1346b797e773e57a5c6c790587ac7705e6cd?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
   
   <details><summary>Additional details and impacted files</summary>
   
   
   
   ```diff
   @@              Coverage Diff              @@
   ##               main    #4671       +/-   ##
   =============================================
   + Coverage     46.15%   85.05%   +38.90%     
   =============================================
     Files          1013      157      -856     
     Lines         38165     7803    -30362     
     Branches       3712        0     -3712     
   =============================================
   - Hits          17615     6637    -10978     
   + Misses        19776     1166    -18610     
   + Partials        774        0      -774     
   ```
   
   | [Flag](https://app.codecov.io/gh/apache/texera/pull/4671/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
   |---|---|---|
   | [agent-service](https://app.codecov.io/gh/apache/texera/pull/4671/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
   | [frontend](https://app.codecov.io/gh/apache/texera/pull/4671/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
   | [python](https://app.codecov.io/gh/apache/texera/pull/4671/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `85.05% <ø> (ø)` | |
   | [scala](https://app.codecov.io/gh/apache/texera/pull/4671/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
   
   Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
   </details>
   
   [:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/texera/pull/4671?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).   
   :loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
   <details><summary> :rocket: New features to boost your workflow: </summary>
   
   - :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
   - :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
   </details>


-- 
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: notifications-unsubscribe@texera.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(scala): fully-qualify ScalaDoc @throws and link references [texera]

Posted by "Yicong-Huang (via GitHub)" <gi...@apache.org>.
Yicong-Huang merged PR #4671:
URL: https://github.com/apache/texera/pull/4671


-- 
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: notifications-unsubscribe@texera.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org