filter kdocs #1288
Merged
filter kdocs #1288
+56
−48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deprecated |
Jolanrensen
requested changes
Jul 1, 2025
| * | ||
| * See also: | ||
| * - [drop][DataFrame.drop], which drops rows based on values within the row. | ||
| * - [distinct][DataFrame.distinct], which filters rows with duplicated values. |
There was a problem hiding this comment.
*filters out? If you say "filters", it could also mean that you only keep rows with duplicate values.
| * | ||
| * See also: [filter], which allows filtering rows based on values within the row. | ||
| * | ||
| * ### This Gather Overload |
| @@ -110,6 +110,9 @@ internal const val CONVERT_TO_URL_REPLACE = "convertToUrl()" | |||
| internal const val TO_URL = "This function is replaced by `toUrl()`. $MESSAGE_1_0" | |||
| internal const val TO_URL_REPLACE = "toUrl()" | |||
|
|
|||
| internal const val FILTER_BY = "This function is deprecated in favor of `filter { }`. $MESSAGE_1_0" | |||
| @@ -110,6 +110,9 @@ internal const val CONVERT_TO_URL_REPLACE = "convertToUrl()" | |||
| internal const val TO_URL = "This function is replaced by `toUrl()`. $MESSAGE_1_0" | |||
| internal const val TO_URL_REPLACE = "toUrl()" | |||
|
|
|||
| internal const val FILTER_BY = "This function is deprecated in favor of `filter { }`. $MESSAGE_1_0" | |||
| internal const val FILTER_BY_REPLACE = "filter { column }" | |||
There was a problem hiding this comment.
I'm not sure whether the ReplaceWith can fully handle this transition... in filterBy { column }, column is a ColumnAccessor<T>, in filter { column }, it's a value T. But let's keep it like this, the user can probably figure it out.
| @ExcludeFromSources | ||
| internal interface FilterByDocs | ||
|
|
||
| /** |
There was a problem hiding this comment.
probably don't need kdocs for this if we're gonna deprecate it, right?
Jolanrensen
approved these changes
Jul 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1278