Kotlin / Kotlin/dataframe

Improve KDoc-snippets usages

Open
#1,713 0 comments 0 reactions 0 assignees View on GitHub
KDocs
Dominant language
Kotlin
Stars
1.1k
Forks
83
Avg merge
4d 12h
Merged PRs (30d)
30

Description

(relevant after #1683)
* Use `SelectingRows.RowFilterSnippet` and `SelectingRows.RowValueFilterSnippet` instead of `EntireRowCondition`/`RowValueCondition` + add KoDEx example template.
* Move `AddExpressionDocs` (rename to `Snippet`!) and add it to other methods Kdocs with `AddExpression`.
* Add similar snippets in all `ExpressionGiven...` helpers.

Contributor guide

Open the contributing guide

Research direction

Start by reading issue #1683 and the existing KDoc snippets around SelectingRows, AddExpressionDocs, and the ExpressionGiven... helpers. Identify every named helper and its current documentation pattern. Done means the requested RowFilterSnippet and RowValueFilterSnippet, renamed Snippet documentation, KoDEx example template, and corresponding snippets are applied consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.