You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "ydash (via GitHub)" <gi...@apache.org> on 2023/09/25 11:27:08 UTC

[GitHub] [incubator-pekko] ydash opened a new pull request, #682: Fix invalid scaladoc links which cannot be found (#353)

ydash opened a new pull request, #682:
URL: https://github.com/apache/incubator-pekko/pull/682

   Refs #353 
   
   I fixed invalid scaladoc links.
   * Add enough package name
   * Fix invalid syntax of links to a method


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] pjfanning commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335760431


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/Scheduler.scala:
##########
@@ -45,7 +45,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   java.lang is imported implicity - same as the top level scala package. If scaladoc is not linking these java.lang classes unless you prefix them like this - then there seems to be a bug that we should report to scala team. I'll have to test out locally if this change actually improves the scaladoc or whether the issue is with links to Java classes generally.



##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/Scheduler.scala:
##########
@@ -45,7 +45,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   java.lang is imported implicitly - same as the top level scala package. If scaladoc is not linking these java.lang classes unless you prefix them like this - then there seems to be a bug that we should report to scala team. I'll have to test out locally if this change actually improves the scaladoc or whether the issue is with links to Java classes generally.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] ydash commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "ydash (via GitHub)" <gi...@apache.org>.
ydash commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1336795869


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/Scheduler.scala:
##########
@@ -45,7 +45,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   In my environment, linking to classes under the top level scala package is also failed without those `scala.` prefix:
   
   https://github.com/apache/incubator-pekko/pull/682/files#diff-d77b49e58aab175ed0d750b8b282f3ad01daab1ba88f38b3a310dc3c2e89e179L126



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] ydash commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "ydash (via GitHub)" <gi...@apache.org>.
ydash commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1336795869


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/Scheduler.scala:
##########
@@ -45,7 +45,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   In my environment, linking to classes under the top level `scala` package is also failed without those `scala.` prefix:
   
   https://github.com/apache/incubator-pekko/pull/682/files#diff-d77b49e58aab175ed0d750b8b282f3ad01daab1ba88f38b3a310dc3c2e89e179L126



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] pjfanning commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1739135915

   @ydash @He-Pin this change is the cause of #687 - I don't know if reverting some parts of this will be enough or if we would be better off doing a full revert and starting again. 
   
   Scaladoc has so many bugs that it may not be worth our while trying to improve it.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] pjfanning commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "pjfanning (via GitHub)" <gi...@apache.org>.
pjfanning commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1735332660

   > @He-Pin You mean it is a bug that failures of linking to classes under `java.lang` package without the `java.lang.` prefix?
   
   Yes @ydash this is what is being requested. Scaladoc should not require us to hack the scaladoc like you are doing in this PR.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335758408


##########
actor/src/main/java/org/apache/pekko/japi/pf/ReceiveBuilder.java:
##########
@@ -19,7 +19,7 @@
 
 /**
  * Used for building a partial function for {@link
- * org.apache.pekko.actor.AbstractActor#createReceive() AbstractActor.createReceive()}.
+ * org.apache.pekko.actor.AbstractActor#createReceive AbstractActor.createReceive()}.

Review Comment:
   this seems wrong too.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1734834597

   @ydash I think that should be a bug in Scaladoc, because in Java, we can do it. would you like to report it scala/bug ?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] ydash commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "ydash (via GitHub)" <gi...@apache.org>.
ydash commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1735050553

   @He-Pin You mean it is a bug that failures of linking to classes under `java.lang` package without the `java.lang.` prefix?
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335759151


##########
actor/src/main/scala/org/apache/pekko/actor/Scheduler.scala:
##########
@@ -477,7 +477,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   I think we can just import this , then there will be no `java.lang.`



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335756743


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/Scheduler.scala:
##########
@@ -45,7 +45,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   Maybe better just import it.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1735340085

   @ydash If you don't have time, I will openup an issue in scala/bug. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin merged pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin merged PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] ydash commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "ydash (via GitHub)" <gi...@apache.org>.
ydash commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335774906


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorRef.scala:
##########
@@ -49,8 +49,8 @@ trait ActorRef[-T] extends RecipientRef[T] with java.lang.Comparable[ActorRef[_]
   /**
    * Unsafe utility method for widening the type accepted by this ActorRef;
    * provided to avoid having to use `asInstanceOf` on the full reference type,
-   * which would unfortunately also work on non-ActorRefs. Use it with caution,it may cause a [[ClassCastException]] when you send a message
-   * to the widened [[ActorRef[U]]].
+   * which would unfortunately also work on non-ActorRefs. Use it with caution,it may cause a [[java.lang.ClassCastException]] when you send a message
+   * to the widened [[ActorRef ActorRef[U]]].

Review Comment:
   It's seems invalid.
   Due to `[[ActorRef[U]]]`, following warn log is appeared:
   ```
   [warn] /path/actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorRef.scala:49:3: Could not find any member to link for "ActorRef[U".
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] ydash commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "ydash (via GitHub)" <gi...@apache.org>.
ydash commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1734808203

   > @ydash thanks, this is epic, but the changeset is large than I expected, will import these classes directly reduce the lines of change?
   
   Probably, it's not possible.
   If you import classes which are used in only scaladoc link, following compile error is appeared:
   ```
   [error] /path/actor/src/main/scala/org/apache/pekko/actor/Scheduler.scala:16:18: Unused import
   [error] Applicable -Wconf / @nowarn filters for this fatal warning: msg=<part of the message>, cat=unused-imports, site=org.apache.pekko.actor
   [error] import java.lang.IllegalArgumentException
   [error]                  ^
   [error] one error found
   [error] (actor / Compile / compileIncremental) Compilation failed
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#issuecomment-1733491114

   @ydash thanks, this is epic, but the changeset is large than I expected, will import these classes directly reduce the lines of change?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335756106


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorRef.scala:
##########
@@ -49,8 +49,8 @@ trait ActorRef[-T] extends RecipientRef[T] with java.lang.Comparable[ActorRef[_]
   /**
    * Unsafe utility method for widening the type accepted by this ActorRef;
    * provided to avoid having to use `asInstanceOf` on the full reference type,
-   * which would unfortunately also work on non-ActorRefs. Use it with caution,it may cause a [[ClassCastException]] when you send a message
-   * to the widened [[ActorRef[U]]].
+   * which would unfortunately also work on non-ActorRefs. Use it with caution,it may cause a [[java.lang.ClassCastException]] when you send a message
+   * to the widened [[ActorRef ActorRef[U]]].

Review Comment:
   this seems invalid?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org


[GitHub] [incubator-pekko] He-Pin commented on a diff in pull request #682: Fix invalid scaladoc links which cannot be found (#353)

Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #682:
URL: https://github.com/apache/incubator-pekko/pull/682#discussion_r1335770832


##########
actor-typed/src/main/scala/org/apache/pekko/actor/typed/Scheduler.scala:
##########
@@ -45,7 +45,7 @@ trait Scheduler {
    * Java API: Schedules a Runnable to be run once with a delay, i.e. a time period that
    * has to pass before the runnable is executed.
    *
-   * @throws IllegalArgumentException if the given delays exceed the maximum
+   * @throws java.lang.IllegalArgumentException if the given delays exceed the maximum

Review Comment:
   Yes, if it can't lik, then its a bug of scaladoc.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org