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.
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
Minor problems with internet slang and formatting in ScalaDoc #4478
Comments
Imported From: https://issues.scala-lang.org/browse/SI-4478?orig=1
|
@soc said: |
@soc said: |
@magarciaEPFL said: |
@soc said: |
@kzys said: However, there are many "wrt" in the source tree.
|
@magarciaEPFL said: Looking better:
|
@soc said: |
@adriaanm said: |
=== What steps will reproduce the problem? ===
http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/scala/collection/immutable/List.html
Look for example at "sortWith".
=== What is the expected behavior? ===
Usage of internet slang should be replaced by a more formal wording.
=== What do you see instead? ===
That is, elements that are equal wrt lt appear in the same order in the sorted sequence as in the original.
I guess "wrt" means "with regard/respect to".
Maybe it would be better to replace these kinds of expressions by better wording. (I think grep'ping through the source might reveal a lot of these internet terms in other files, too.)
Additionally, the parens around "wrt lt" got eaten by ScalaDoc and the deprecated "sort" method has broken "=>"s in the documentation.
The text was updated successfully, but these errors were encountered: