docs: update Scala comments that reference the removed iceberg-writes.md page
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 83/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- scala
- Domain
- documentation
Research direction
Read the four cited Scala comments in CometIcebergEndToEndBenchmark.scala, CometIcebergWriteBenchmark.scala, IcebergWriteProtoTranslation.scala, and CometIcebergWriteActionSuite.scala. Update their references to docs/source/user-guide/latest/iceberg.md, naming the Writes section where useful. Done when all four comments point to the intended user guide page and section.
Written by the indexing model from the issue text.
Description
What is the problem the feature request solves?
#7090 folds docs/source/user-guide/latest/iceberg-writes.md into the Writes section of iceberg.md (headings demoted one level, so the anchors are unchanged). Four Scala comments still name the old page. #7090 leaves them alone so the docs-only change does not trigger the Scala CI tiers:
spark/src/test/scala/org/apache/spark/sql/benchmark/CometIcebergEndToEndBenchmark.scala:64andspark/src/test/scala/org/apache/spark/sql/benchmark/CometIcebergWriteBenchmark.scala:64namedocs/source/user-guide/latest/iceberg-writes.md, which no longer exists.spark/src/main/scala/org/apache/comet/serde/operator/IcebergWriteProtoTranslation.scala:202andspark/src/test/scala/org/apache/comet/CometIcebergWriteActionSuite.scala:4517say onlyiceberg-writes.md, which now resolves to the contributor-guide page rather than the user-guide section they mean.
Describe the potential solution
Point all four at docs/source/user-guide/latest/iceberg.md, naming the section where useful (for example "Accepted divergences" under Writes). This can ride along with the next PR that touches these files.
Additional context
Raised in review of #7090.
- Dominant language
- Scala
- Stars
- 1.3k
- Forks
- 405
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 321
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/datafusion-comet
-
area:ci enhancement priority:low requires-triage
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
apache/datafusion-comet#7319 · 1 comment ·
Maintainers usually reply within 1 day
-
area:ci bug priority:low requires-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/datafusion-comet#7315 ·
Maintainers usually reply within 1 day
-
requires-triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/datafusion-comet#7240 ·
Maintainers usually reply within 1 day
-
bug priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
apache/datafusion-comet#7176 ·
Maintainers usually reply within 1 day
-
requires-triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
apache/datafusion-comet#7001 ·
Maintainers usually reply within 1 day
All issues in apache/datafusion-comet
Similar issues
-
area:build priority:P2 status:backlog
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
KD5UJC-XYZ/scarab#648 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
lichess-org/lila#22324 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
canton-network/splice#8142 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day