Yicong-Huang opened a new issue, #4670:
URL: https://github.com/apache/texera/issues/4670
### Task Summary
The Scala build emits 29 unique `[warn] ... Could not find any member to
link for "X".` warnings in ScalaDoc. Each one is a `[[X]]` reference (typically
inside `@throws`) where `X` is not imported and not fully qualified, so
ScalaDoc cannot resolve it.
These are pure documentation warnings — fixing them is a one-line change per
site (either `import X` at the top of the file or rewrite as
`[[fully.qualified.X]]` / `@throws fully.qualified.X`). No behavioral change. A
single PR can clean up all 29.
**Source** — most recent main-push scala build: run `25247623117`, sha
`9a8214d`.
### Inventory (29 sites, grouped by file)
#### `common/workflow-operator/.../source/sql/SQLSourceOpExec.scala` — 9
| line | broken link |
|---|---|
| 141 | `SQLException` |
| 164 | `SQLException` |
| 179 | `SQLException` |
| 210 | `IllegalArgumentException` |
| 256 | `IllegalArgumentException` |
| 304 | `IllegalArgumentException` |
| 331 | `IllegalArgumentException` |
| 368 | `SQLException` |
| 377 | `SQLException` |
| 388 | `IllegalArgumentException` |
#### `amber/.../engine/architecture/controller/execution/` — 5
| line | broken link |
|---|---|
| `OperatorExecution.scala:44` | `AssertionError` |
| `RegionExecution.scala:45` | `AssertionError` |
| `RegionExecution.scala:94` | `AssertionError` |
| `WorkflowExecution.scala:37` | `AssertionError` |
| `WorkflowExecution.scala:122` | `NoSuchElementException` |
#### `common/workflow-core/.../` — 7
| file:line | broken link |
|---|---|
| `core/storage/FileResolver.scala:43` | `FileNotFoundException` |
| `core/storage/VFSURIFactory.scala:42` | `IllegalArgumentException` |
| `core/storage/util/LakeFSStorageClient.scala:394` |
`IllegalArgumentException` |
| `core/tuple/Tuple.scala:32` | `IllegalArgumentException` |
| `amber/util/ArrowUtils.scala:114` | `AttributeTypeException` |
| `amber/util/ArrowUtils.scala:258` | `AttributeTypeException` |
| `service/util/LargeBinaryManager.scala:48` | `Exception` |
| `service/util/S3StorageClient.scala:265` |
`software.amazon.awssdk.services.s3.model.UploadPartRequest` |
#### Other
| file:line | broken link |
|---|---|
|
`common/workflow-operator/.../source/sql/asterixdb/AsterixDBSourceOpExec.scala:193`
| `IllegalArgumentException` |
|
`common/workflow-operator/.../com/kjetland/jackson/jsonSchema/annotations/JsonSchemaInject.java:32`
| `#json()` |
|
`common/workflow-operator/.../com/kjetland/jackson/jsonSchema/annotations/JsonSchemaInject.java:42`
| `#jsonSupplier()` |
| `common/pybuilder/.../EncodableInspector.scala:103` | `AnnotatedType` |
| `amber/.../web/resource/dashboard/hub/HubResource.scala:505` |
`BadRequestException` |
|
`computing-unit-managing-service/.../resource/ComputingUnitManagingResource.scala:587`
| `DashboardWorkflowComputingUnit` |
### Fix recipe
Per file, prefer fully-qualifying or using `@throws` with the FQN — both
avoid touching imports and are the most local change:
```scala
// before
/**
* @throws [[IllegalArgumentException]] if foo
*/
// after (option A: fully-qualified link)
/**
* @throws [[java.lang.IllegalArgumentException]] if foo
*/
// after (option B: @throws with FQN — preferred for thrown exceptions)
/**
* @throws java.lang.IllegalArgumentException if foo
*/
```
Most JDK exceptions live in `java.lang` (`AssertionError`,
`IllegalArgumentException`, `NoSuchElementException`, `Exception`) or `java.io`
(`FileNotFoundException`) or `java.sql` (`SQLException`).
Project-internal references (`AttributeTypeException`,
`BadRequestException`, `DashboardWorkflowComputingUnit`, `AnnotatedType`) need
their FQN resolved by reading the surrounding file — usually a 1-line import at
the top is enough.
For the two Java sources under `JsonSchemaInject.java` (vendored Jackson
schema annotation copies), `#json()` / `#jsonSupplier()` are method-link syntax
— they need a class context. Either fix to `JsonSchemaInject#json()` or just
delete the broken `@see` lines if upstream removed those methods.
### Out of scope
- Other build-warning categories (deprecations, outer-reference type tests,
existential types, forward references, scalafix unused suppression,
sbt-native-packager `maintainer` empty). Tracked separately.
### Task Type
- [x] Documentation
- [x] Refactor / Cleanup
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
