SI-8140 Documentation references java.lang.String directly #4591
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| * Java String (see the documentation corresponding to your Java version, for | ||
| * example [[http://docs.oracle.com/javase/7/docs/api/java/lang/String.html]]) or | ||
| * are added implicitly through [[scala.collection.immutable.StringOps]]. | ||
| */ |
There was a problem hiding this comment.
There are a couple of JavaDoc-style comments still in Predef, but it shows Scala pride to use Scala-style, as at the top. It saves vertical space. Also, might as well link to Java 8 doc.
vsalvis
force-pushed
the
vsalvis-stringdoc
branch
from
ce457c7 to
d0996ae
Compare
| * This class serves as a wrapper providing `String`s with all the operations | ||
| * found in indexed sequences. Where needed, instances of `String` object | ||
| * This class serves as a wrapper providing [[scala.Predef.String]]s with all the operations | ||
| * found in indexed sequences. Where needed, instances of `String` objects |
There was a problem hiding this comment.
The word objects doesn't actually belong. Even "instances of String" is possibly redundant. "Strings are implicitly converted into instances of this class."
vsalvis
force-pushed
the
vsalvis-stringdoc
branch
from
d0996ae to
b1c7d21
Compare
|
Thanks @som-snytt, fixed your comments. |
SethTisue
added a commit
that referenced
this pull request
Jun 30, 2015
SI-8140 Documentation references java.lang.String directly
|
LGTM. Thank you for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a documentation fix that should make it easier to get to the documentation of java.lang.String. Properly fixing this issue would require a complete redesign of the scaladoc tool to somehow add documentation for external entities.