Details

      Description

      The Scaladoc comments for some types and members are either missing, incomplete, or of low quality. Types: scala.concurrent.Awaitable, scala.concurrent.ExecutionContext

      The doc comment of Future.firstCompletedOf, for example, should be improved.

        Activity

        Hide
        Heather Miller added a comment - - edited

        Elevating this, as it's a critical scaladoc/API documentation bug that needs to be resolved before the RC.

        Show
        Heather Miller added a comment - - edited Elevating this, as it's a critical scaladoc/API documentation bug that needs to be resolved before the RC.
        Hide
        Heather Miller added a comment -

        Philipp- there's also a way in Scaladoc to prevent entire packages from being documented. For the sake of simplicity, I'd argue that the scala.concurrent.impl package ought not to be documented. While you're cleaning up the scala.concurrent API docs, could you also go ahead and prevent the impl package from being documented?

        Show
        Heather Miller added a comment - Philipp- there's also a way in Scaladoc to prevent entire packages from being documented. For the sake of simplicity, I'd argue that the scala.concurrent.impl package ought not to be documented. While you're cleaning up the scala.concurrent API docs, could you also go ahead and prevent the impl package from being documented?
        Hide
        Philipp Haller added a comment -

        I just submitted a pull request which fixes several issues:
        https://github.com/scala/scala/pull/1485

        Show
        Philipp Haller added a comment - I just submitted a pull request which fixes several issues: https://github.com/scala/scala/pull/1485
        Hide
        Heather Miller added a comment -
        Show
        Heather Miller added a comment - Updated pull at, https://github.com/scala/scala/pull/1486

          People

          • Assignee:
            Philipp Haller
            Reporter:
            Philipp Haller
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development