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.

Sign up for GitHub

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

Jump to bottom

Address review comments for Sample API #3364

Merged
merged 2 commits into from
Nov 22, 2023
Merged

Address review comments for Sample API #3364

merged 2 commits into from
Nov 22, 2023

Conversation

IgnatBeresnev
Copy link
Member

Continuation of #3195 (review)

@IgnatBeresnev IgnatBeresnev self-assigned this Nov 22, 2023
vmishenev
vmishenev approved these changes Nov 22, 2023
View reviewed changes
...-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/kdoc/ResolveKDocLink.kt Outdated
@@ -37,7 +37,7 @@ internal inline fun DRI?.ifUnresolved(action: () -> Unit): DRI? = this ?: run {
*/
internal fun KtAnalysisSession.resolveKDocTextLinkDRI(link: String, context: PsiElement? = null): DRI? {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

resolveKDocTextLinkToDRI

Copy link
Member Author

@IgnatBeresnev IgnatBeresnev Nov 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't rename this one because it was consistent with the function resolveKDocTextLinkSymbol below, but I guess I'll rename it to resolveKDocTextLinkToSymbol as well

89afca3

@IgnatBeresnev
Copy link
Member Author

#3195 (comment):

I missed in the first review the message does not have the location of sample link. It can be useful to find the link in the input code.

I'm not sure I can add it as the API function does not have a location per se, it can be called from anywhere with any fully qualified link.

I think this needs to be added to DefaultSamplesTransformer somewhere, which I didn't touch much. As I replied to Oleg, DefaultSamplesTransformer is going to be changed in #3041 anyway, so I added this comment into the issue, it'll be a better time to address it

@IgnatBeresnev IgnatBeresnev changed the title Address review fixes for Sample APi Address review comments for Sample API Nov 22, 2023
@IgnatBeresnev IgnatBeresnev merged commit 99aa026 into master Nov 22, 2023
9 checks passed
@IgnatBeresnev IgnatBeresnev deleted the fix-samples-post-review branch November 22, 2023 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vmishenev vmishenev vmishenev approved these changes

Assignees

@IgnatBeresnev IgnatBeresnev

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@IgnatBeresnev @vmishenev