Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation metadata and overloads for distinct API #1023

Merged
merged 3 commits into from
Jan 28, 2025
Merged

Conversation

zaleslaw
Copy link
Collaborator

@zaleslaw zaleslaw commented Jan 21, 2025

Fixes #817

@Jolanrensen Jolanrensen self-requested a review January 27, 2025 13:16
@Jolanrensen
Copy link
Collaborator

I experimented a bit with a @see href template. What do you think about something like this?

/** https://kotlin.github.io/dataframe */
interface Url

/** @see <a href="{@include [Url]}/$[URL_PART]">See $[NAME]=this on the documentation website.</a> */
private interface SeeTag {
    // The part after the base url, if not supplied, it defaults to the base url
    interface URL_PART

    // The name of the concept the user will see in the @see link, defaults to "this"
    interface NAME
}

...

/** @include [SeeTag] {@set [SeeTag.URL_PART] distinct.html}{@set [SeeTag.NAME] `distinct`} */
interface SeeDistinctDocumentation

I've included the "@see" part in the doc interface, because <a href ... does not render outside @see. WDYT?

This commit adds a new entry for the `remove` function to the DocumentationUrls interface, linking it to the corresponding documentation page. This ensures consistency and provides easy access to the remove function details.
# Conflicts:
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
@zaleslaw
Copy link
Collaborator Author

@Jolanrensen let's make common refactoring of URls/See tag support as a separate PR

@zaleslaw zaleslaw merged commit 24add0a into master Jan 28, 2025
3 of 4 checks passed
@Jolanrensen
Copy link
Collaborator

Jolanrensen commented Jan 29, 2025

@zaleslaw you forgot the linter + apiDump. The TC build fails.

You can suppress the argument name by putting @Suppress("ClassName") next to your DistinctDocs interface.

@zaleslaw
Copy link
Collaborator Author

Thanks @Jolanrensen will fix soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add KDocs for distinct/distinctBy
2 participants