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.

        Activity

        Hide
        Simon Ochsenreither added a comment -

        Fixes things mentioned, plus a few other ones.

        Show
        Simon Ochsenreither added a comment - Fixes things mentioned, plus a few other ones.
        Hide
        Simon Ochsenreither added a comment -
        Show
        Simon Ochsenreither added a comment - Please pull https://github.com/scala/scala/pull/10 instead.
        Hide
        Miguel Garcia added a comment -

        A patch has been provided.

        Show
        Miguel Garcia added a comment - A patch has been provided.
        Hide
        Simon Ochsenreither added a comment -
        Show
        Simon Ochsenreither added a comment - https://github.com/soc/scala/commit/264e9081736184195ca48ff808cacd87f8e8272a this is the actual commit you need.
        Hide
        Kato Kazuyoshi added a comment -

        Formatting problem is fixed. Isn't it?

        However, there are many "wrt" in the source tree.

        % git grep wrt | wc -l
              40
        %
        
        Show
        Kato Kazuyoshi added a comment - Formatting problem is fixed. Isn't it? However, there are many "wrt" in the source tree. % git grep wrt | wc -l 40 %
        Hide
        Miguel Garcia added a comment -

        Looking better:

        % git grep wrt | wc -l
        30
        
        Show
        Miguel Garcia added a comment - Looking better: % git grep wrt | wc -l 30
        Show
        Simon Ochsenreither added a comment - Fixed in https://github.com/scala/scala/commit/b5196d81356722a3c26c57037e05d42722592a6b
        Show
        Adriaan Moors added a comment - https://github.com/scala/scala/pull/1308

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development