Skip to content

Makes the label look a bit more vertically centered.#4

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.

Sign up for GitHub

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

Closed
soc wants to merge 3 commits into from
Closed

Makes the label look a bit more vertically centered. #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a11aac0
Updated incorrect labels, marked gossary and collections as Available
heathermiller Nov 7, 2011
432f616
Merge branch 'gh-pages' of github.com:scala/scala.github.com into gh-…
heathermiller Nov 7, 2011
1ec3c9c
Worked on the wording:
soc Nov 9, 2011
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/frontpage-content.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@
<h3><a href="{{site.baseurl }}/tutorials">Tutorials</a> <span class="label success">Some Available</span></h3>
<p>Some tutorials, such as the <em>Scala for Java Programmers</em> guide is already available. Others are currently being converted to markdown markup for inclusion here.</p>

<h3><a href="{{site.baseurl }}/glossary">Glossary</a> <span class="label warning">Pending Permission</span></h3>
<h3><a href="{{site.baseurl }}/glossary">Glossary</a> <span class="label success">Available</span></h3>
<p>Pending permission from Artima Inc., we'd like to include the glossary from <em>Programming in Scala</em> here, for quick and easy reference.</p>

<h3><a href="{{site.baseurl }}/cheatsheets">Cheatsheets</a> <span class="label success">Available</span></h3>
Expand Down
2 changes: 1 addition & 1 deletion overviews/core/_posts/2010-09-07-collections.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ layout: overview
title: Scala's Collections Library
disqus: true
label-color: success
label-text: Available in Part
label-text: Available
partof: collections
---

Expand Down
43 changes: 19 additions & 24 deletions tutorials/FAQ/finding-symbols.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,8 +36,8 @@ So, let's see them.
Keywords/reserved symbols
-------------------------

There are some symbols in Scala that are special. Two of them are considered
proper keywords, while others are just "reserved". They are:
There are a few symbols in Scala that are special and cannot be defined or used used as method names.
Two of them are considered proper keywords, while others are just "reserved". They are:

// Keywords
<- // Used on for-comprehensions, to separate pattern from generator
Expand DownExpand Up@@ -65,11 +65,11 @@ These are all _part of the language_, and, as such, can be found in any text
that properly describe the language, such as [Scala Specification][1](PDF)
itself.

The last one, the underscore, deserve a special description, because it is so
widely used, and has so many different meanings. Here's a sample:
The last one, the underscore, deserve a special description, because it is
widely used, and has different meanings depending on the context. Here's a sample:

import scala._ // Wild card -- all of Scala is imported
import scala.{Predef => _, _ } // Exception, everything except Predef
import scala.{Predef => _, _ } // Exclusion, everything except Predef
def f[M[_]] // Higher kinded type parameter
def f(m: M[_]) // Existential type
_ + _ // Anonymous function placeholder parameter
Expand All@@ -80,34 +80,30 @@ widely used, and has so many different meanings. Here's a sample:
f(xs: _*) // Sequence xs is passed as multiple parameters to f(ys: T*)
case Seq(xs @ _*) // Identifier xs is bound to the whole matched sequence

I probably forgot some other meaning, though.

Automatically imported methods
------------------------------

So, if you did not find the symbol you are looking for in the list above, then
If you did not find the symbol you are looking for in the list above, then
it must be a method, or part of one. But, often, you'll see some symbol and the
documentation for the class will not have that method. When this happens,
either you are looking at a composition of one or more methods with something
else, or the method has been imported into scope, or is available through an
imported implicit conversion.

These _can still be found_ on [ScalaDoc][2]: you just have to know where to
look for them. Or, failing that, look at the [index][3] (presently broken on
2.9.1, but available on nightly).
These can also be found in ScalaDoc's [index][2].

Every Scala code has three automatic imports:

// Not necessarily in this order
import _root_.java.lang._ // _root_ denotes an absolute path
import _root_.scala._
import _root_.scala.Predef._
import java.lang._
import scala._
import scala.Predef._

The first two only make classes and singleton objects available. The third one
contains all implicit conversions and imported methods, since [`Predef`][4] is
contains all implicit conversions and imported methods, since [`Predef`][3] is
an object itself.

Looking inside `Predef` quickly show some symbols:
Looking inside `Predef` quickly shows some symbols:

class <:<
class =:=
Expand All@@ -120,18 +116,18 @@ object of type that is receiving the method. For example:

"a" -> 1 // Look for an implicit from String, AnyRef, Any or type parameter

In the above case, `->` is defined in the class [`ArrowAssoc`][5] through the
In the above case, `->` is defined in the class [`ArrowAssoc`][4] through the
method `any2ArrowAssoc` that takes an object of type `A`, where `A` is an
unbounded type parameter to the same method.

Common methods
--------------

So, many symbols are simply methods on a class. For instance, if you do
Many symbols are simply methods on a class. For instance, if you do

List(1, 2) ++ List(3, 4)

You'll find the method `++` right on the ScalaDoc for [List][6]. However,
You'll find the method `++` right on the ScalaDoc for [List][5]. However,
there's one convention that you must be aware when searching for methods.
Methods ending in colon (`:`) bind _to the right_ instead of the left. In other
words, while the above method call is equivalent to:
Expand DownExpand Up@@ -187,9 +183,8 @@ And, of course, there's various combinations that can appear in code:


[1]: http://www.scala-lang.org/sites/default/files/linuxsoft_archives/docu/files/ScalaReference.pdf
[2]: http://www.scala-lang.org/api/current/index.html
[3]: http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/index.html#index.index-_
[4]: http://www.scala-lang.org/api/current/index.html#scala.Predef$
[5]: http://www.scala-lang.org/api/current/scala/Predef$$ArrowAssoc.html
[6]: http://www.scala-lang.org/api/current/index.html#scala.collection.immutable.List
[2]: http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/index.html#index.index-_
[3]: http://www.scala-lang.org/api/current/index.html#scala.Predef$
[4]: http://www.scala-lang.org/api/current/scala/Predef$$ArrowAssoc.html
[5]: http://www.scala-lang.org/api/current/index.html#scala.collection.immutable.List