Add KDocs for the remaining column-type predicates in `DataColumnType.kt`
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 1.1k
- Forks
- 83
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 30
Description
Add KDocs for the remaining column-type predicates in DataColumnType.kt
The file core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataColumnType.kt is partially documented. Add concise KDocs to the predicates that still lack them.
Already documented (leave as-is)
isNumber, isMixedNumber, isPrimitiveNumber, isPrimitiveOrMixedNumber, valuesAreComparable. (isComparable is deprecated with ERROR level — out of scope.)
Scope — not documented
AnyCol.isColumnGroup()AnyCol.isFrameColumn()AnyCol.isValueColumn()AnyCol.isSubtypeOf(type: KType)AnyCol.isSubtypeOf<T>()(reified)AnyCol.isType<T>()(reified)AnyCol.isList()
KDocs should explain
- The column-kind checks (
isColumnGroup/isFrameColumn/isValueColumn): each returnstruewhen the column is of that kind (ColumnKind.Group/Frame/Value). Mention that they carry a Kotlin contract — atrueresult smart-casts the receiver toColumnGroup<*>/FrameColumn<*>/ValueColumn<*>. isSubtypeOf(type)/isSubtypeOf<T>(): returnstruewhen the column's element type is a subtype of the given type, with nullability respected (a nullable column is not a subtype of a non-nullable type).isType<T>(): returnstrueonly when the column's element type is exactlyT(no subtyping) — contrast withisSubtypeOf.isList(): returnstruewhen the column's element type class isList.
Acceptance criteria
- All seven predicates listed under Scope have concise KDocs; the already-documented predicates are preserved.
- The kind-check KDocs note the smart-cast contract.
- The KDocs make the
isSubtypeOf(subtype, nullability-aware) vsisType(exact type) distinction explicit. - No documentation is added for the deprecated
isComparable.
Contributor 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.
Research direction
Start in core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataColumnType.kt and review the existing KDocs for the documented predicates. Add concise KDocs for the seven listed predicates, including the kind-check smart-cast contracts and the nullability-aware subtype versus exact-type distinction. Done means all seven are documented, existing KDocs are unchanged, and isComparable remains undocumented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100