Skip to content

Jdk (7): filled in @param, @tparam, and @return tags that were missed last time#26126

Draft
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-tags-jdk-cleanup
Draft

Jdk (7): filled in @param, @tparam, and @return tags that were missed last time#26126
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-tags-jdk-cleanup

Conversation

@bvenners
Copy link
Copy Markdown
Contributor

As a next step in improving the Scaladoc documentation for the Scala 3 standard library, this PR fills in @param, @tparam, and @return tags for scala.jdk that were missed in the previous batch of PRs. I'm submitting it as a draft PR so to get CI to run on it, to see if it breaks anything, and to start getting feedback. We automated the generation of these changes and are starting to review them. We will review them all before making the PR non-draft. Please let me know if you see anything specific that you think could be improved.

Copy link
Copy Markdown
Contributor

@cheeseng cheeseng left a comment

Choose a reason for hiding this comment

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

Added some suggestions.

* `import scala.jdk.FunctionConverters._` and use the extension methods instead.
*
* @tparam T the type of the first (object) argument to the consumer
* @tparam T the type of the first (object) argument to the consumer (the second argument is a primitive)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we says Double instead of primitive here?

* `import scala.jdk.FunctionConverters._` and use the extension methods instead.
*
* @tparam T the type of the first (object) argument to the consumer
* @tparam T the type of the first (object) argument to the consumer (the second argument is a primitive)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we says Double instead of primitive here?

* `import scala.jdk.FunctionConverters._` and use the extension methods instead.
*
* @tparam T the type of the first (object) argument to the consumer
* @tparam T the type of the first (object) argument to the consumer (the second argument is a primitive)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we says Int instead of primitive here?

* `import scala.jdk.FunctionConverters._` and use the extension methods instead.
*
* @tparam T the type of the first (object) argument to the consumer
* @tparam T the type of the first (object) argument to the consumer (the second argument is a primitive)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we says Int instead of primitive here?

* `import scala.jdk.FunctionConverters._` and use the extension methods instead.
*
* @tparam T the type of the first (object) argument to the consumer
* @tparam T the type of the first (object) argument to the consumer (the second argument is a primitive)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we says Int instead of primitive here?

* `import scala.jdk.FunctionConverters._` and use the extension methods instead.
*
* @tparam T the type of the first (object) argument to the consumer
* @tparam T the type of the first (object) argument to the consumer (the second argument is a primitive)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we says Int instead of primitive here?

* [[DoubleAccumulator]].
*
* @tparam CC the covariant higher-kinded type constructor for the specific accumulator collection, constrained to `mutable.Seq`
*
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we do not need the extra line here.

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.

2 participants