Uploaded image for project: 'Scala Programming Language'
  1. Scala Programming Language
  2. SI-4478

Minor problems with internet slang and formatting in ScalaDoc

    Details

      Description

      === 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.

        Attachments

          Activity

            People

            • Assignee:
              soc Simon Ochsenreither
              Reporter:
              soc Simon Ochsenreither
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: