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

Fix Scaladoc crash when extending non-Scala-3 classes (short-term fix for 3.3.x) #16759

Merged
merged 1 commit into from
Feb 2, 2023
Merged

Fix Scaladoc crash when extending non-Scala-3 classes (short-term fix for 3.3.x) #16759

merged 1 commit into from
Feb 2, 2023

Conversation

yzia2000
Copy link
Contributor

@yzia2000 yzia2000 commented Jan 24, 2023 •
edited by SethTisue
Loading

Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples — check for whether the non-scala3 parent exists before checking the start and end of the span to confirm whether the span exists in getParentsAsTreeSymbolTuples.

Fixes #15927

@yzia2000 yzia2000 changed the title Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples DRAFT: Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples Jan 24, 2023
@yzia2000 yzia2000 changed the title DRAFT: Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples Jan 24, 2023
@yzia2000 yzia2000 marked this pull request as draft January 24, 2023 16:53
@SethTisue SethTisue self-assigned this Jan 24, 2023
@SethTisue SethTisue mentioned this pull request Jan 24, 2023
Closed
@yzia2000
Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples
1978bcb 
Fixes scala#15927

Check for whether the non-scala3 parent exists before checking the start
and end of the span to confirm whether the span exists in
getParentsAsTreeSymbolTuples.
@SethTisue SethTisue added the backport:nominated If we agree to backport this PR, replace this tag with "backport:accepted", otherwise delete it. label Jan 24, 2023
@jan-pieter jan-pieter mentioned this pull request Jan 24, 2023
Closed
@SethTisue SethTisue changed the title Added jpath check to ClassLikeSupport getParentsAsTreeSymbolTuples Fix Scaladoc crash when extending non-Scala-3 classes (short-term fix for 3.3.x) Jan 24, 2023
@SethTisue SethTisue marked this pull request as ready for review January 24, 2023 23:59
@SethTisue SethTisue removed their assignment Jan 25, 2023
Sporarum
Sporarum reviewed Feb 1, 2023
View reviewed changes
Copy link
Contributor

@Sporarum Sporarum left a comment

Choose a reason for hiding this comment

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

While this seems fine to me, I do not have enough familiarity with the scaladoc codebase to approve this PR

I therefore request a review from @rochala instead

@Sporarum Sporarum requested a review from rochala February 1, 2023 13:31
@Sporarum Sporarum assigned rochala and unassigned Sporarum Feb 1, 2023
@Kordyjan Kordyjan added this to the 3.3.0 backports milestone Feb 2, 2023
@Kordyjan
Copy link
Contributor

Kordyjan commented Feb 2, 2023

@Florian3k can you take a look?

@Kordyjan Kordyjan merged commit 04f5a0b into scala:main Feb 2, 2023
@Kordyjan Kordyjan added backport:accepted This PR needs to be backported, once it's been backported replace this tag by "backport:done" and removed backport:nominated If we agree to backport this PR, replace this tag with "backport:accepted", otherwise delete it. labels Feb 2, 2023
@Kordyjan Kordyjan mentioned this pull request Feb 15, 2023
Merged
Kordyjan added a commit that referenced this pull request Feb 15, 2023
@Kordyjan
Backport "Added jpath check to ClassLikeSupport getParentsAsTreeSym…
7ee369f 
…bolTuples" (#16928)

Backports #16759
@Kordyjan Kordyjan added backport:done This PR was successfully backported. and removed backport:accepted This PR needs to be backported, once it's been backported replace this tag by "backport:done" labels Feb 17, 2023
@Kordyjan Kordyjan removed this from the 3.3.0 backports milestone Aug 2, 2023
@Kordyjan Kordyjan added this to the 3.3.1 milestone Aug 2, 2023
@aaronp
Copy link

aaronp commented May 13, 2024 •
edited
Loading

I'm currently seeing this issue w/ scala 3.4.1 and sbt 1.10.1

I found it was due to having this:

trait ~>[F[_], G[_]] {
  def apply[A])( fa: F[A]) : G[A]
 }

Turns out scaladoc didn't like the "~>" name, so I renamed it.

@SethTisue
Copy link
Member

@aaronp Thanks for the report — this is helpful. Would you mind opening a new ticket on it?

@aaronp
Copy link

aaronp commented May 21, 2024

Sure thing - thanks!

@aaronp
Copy link

aaronp commented May 21, 2024

I've just had a go trying to create a minimum reproducible example to no avail, so I think I'll leave it for now. Thanks Seth

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sporarum Sporarum Sporarum left review comments

@Florian3k Florian3k Florian3k approved these changes

@rochala rochala Awaiting requested review from rochala

Assignees

@rochala rochala

Labels
backport:done This PR was successfully backported.
Projects
None yet
Milestone
3.3.1
Development

Successfully merging this pull request may close these issues.

Scaladoc generation fails when extending some Java-defined or Scala-2-defined classes
7 participants
@yzia2000 @Kordyjan @aaronp @SethTisue @Florian3k @Sporarum @rochala