Skip to content
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

Closed
scabug opened this issue Apr 12, 2011 · 9 comments

Comments

Projects
None yet
2 participants
@scabug
Copy link

commented Apr 12, 2011

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

@scabug

This comment has been minimized.

Copy link
Author

commented Apr 12, 2011

Imported From: https://issues.scala-lang.org/browse/SI-4478?orig=1
Reporter: @soc
Other Milestones: 2.10.0
Attachments:

@scabug

This comment has been minimized.

Copy link
Author

commented Apr 14, 2011

@soc said:
Fixes things mentioned, plus a few other ones.

@scabug

This comment has been minimized.

Copy link
Author

commented Apr 14, 2011

@soc said:
Please pull scala/scala#10 instead.

@scabug

This comment has been minimized.

Copy link
Author

commented Apr 22, 2011

@magarciaEPFL said:
A patch has been provided.

@scabug

This comment has been minimized.

Copy link
Author

commented Apr 22, 2011

@soc said:
soc/scala@264e908 this is the actual commit you need.

@scabug

This comment has been minimized.

Copy link
Author

commented Apr 23, 2012

@kzys said:
Formatting problem is fixed. Isn't it?

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

% git grep wrt | wc -l
      40
%
@scabug

This comment has been minimized.

Copy link
Author

commented May 4, 2012

@magarciaEPFL said:

Looking better:

% git grep wrt | wc -l
30
@scabug

This comment has been minimized.

Copy link
Author

commented Sep 17, 2012

@soc said:
Fixed in scala/scala@b5196d8

@scabug scabug closed this Sep 17, 2012

@scabug

This comment has been minimized.

Copy link
Author

commented Oct 3, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.