sokojh opened a new pull request, #13784:
URL: https://github.com/apache/iceberg/pull/13784
### Description
This PR fixes incorrect JavaDoc `@param` descriptions in the
`TripleWriter` interface that have been present since the initial
commit in 2018.
The issue was caused by copy-paste errors where all type-specific
write methods incorrectly described their `value` parameter as "the
boolean value", which was only correct for the `writeBoolean()`
method. This inconsistency could confuse developers implementing or
using the `TripleWriter` interface.
### Background
The `TripleWriter` interface is used internally in Parquet column
writers to handle different data types. Each write method accepts a
repetition level and a value of a specific type, but the JavaDoc
incorrectly described all values as boolean.
### Changes
Fixed JavaDoc `@param` descriptions for the following methods in `p
arquet/src/main/java/org/apache/iceberg/parquet/TripleWriter.java`:
- `writeInteger(int rl, int value)` - changed from "the boolean
value" to "the integer value"
- `writeLong(int rl, long value)` - changed from "the boolean
value" to "the long value"
- `writeFloat(int rl, float value)` - changed from "the boolean
value" to "the float value"
- `writeDouble(int rl, double value)` - changed from "the boolean
value" to "the double value"
- `writeBinary(int rl, Binary value)` - changed from "the boolean
value" to "the binary value"
### Tests
This is a documentation-only change with no functional impact. No
new tests are required as the code behavior remains unchanged.
### Notes
- This is my first contribution to Apache Iceberg
- The issue has been present since commit d972f45d93 (June 2018)
- All changes follow the existing JavaDoc style and conventions in
the codebase
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
