Git Product home page Git Product logo

docs.scala-lang's Introduction

This is Scala 2! Welcome!

This is the home of the Scala 2 standard library, compiler, and language spec.

For Scala 3, visit scala/scala3.

How to contribute

Issues and bug reports for Scala 2 are located in scala/bug. That tracker is also where new contributors may find issues to work on: good first issues, help wanted.

For coordinating broader efforts, we also use the scala/scala-dev tracker.

To contribute here, please open a pull request from your fork of this repository.

Be aware that we can't accept additions to the standard library, only modifications to existing code. Binary compatibility forbids adding new public classes or public methods. Additions are made to scala-library-next instead.

We require that you sign the Scala CLA before we can merge any of your work, to protect Scala's future as open source software.

The general workflow is as follows.

  1. Find/file an issue in scala/bug (or submit a well-documented PR right away!).
  2. Fork the scala/scala repo.
  3. Push your changes to a branch in your forked repo. For coding guidelines, go here.
  4. Submit a pull request to scala/scala from your forked repo.

For more information on building and developing the core of Scala, read the rest of this README, especially for setting up your machine!

Get in touch!

In order to get in touch with other Scala contributors, join the #scala-contributors channel on the Scala Discord chat, or post on contributors.scala-lang.org (Discourse).

If you need some help with your PR at any time, please feel free to @-mention anyone from the list below, and we will do our best to help you out:

username talk to me about...
@lrytz back end, optimizer, named & default arguments, reporters
@retronym 2.12.x branch, compiler performance, weird compiler bugs, lambdas
@SethTisue getting started, build, CI, community build, Jenkins, docs, library, REPL
@dwijnand pattern matcher, MiMa, partest
@som-snytt warnings/lints/errors, REPL, compiler options, compiler internals, partest
@Ichoran collections library, performance
@viktorklang concurrency, futures
@sjrd interactions with Scala.js
@NthPortal library, concurrency, scala.math, LazyList, Using, warnings
@bishabosha TASTy reader
@joroKr21 higher-kinded types, implicits, variance

P.S.: If you have some spare time to help out around here, we would be delighted to add your name to this list!

Branches

Target the oldest branch you would like your changes to end up in. We periodically merge forward from older release branches (e.g., 2.12.x) to new ones (e.g. 2.13.x).

If your change is difficult to merge forward, you may be asked to also submit a separate PR targeting the newer branch.

If your change is version-specific and shouldn't be merged forward, put [nomerge] in the PR name.

If your change is a backport from a newer branch and thus doesn't need to be merged forward, put [backport] in the PR name.

Choosing a branch

Most changes should target 2.13.x. We are increasingly reluctant to target 2.12.x unless there is a special reason (e.g. if an especially bad bug is found, or if there is commercial sponsorship).

The 2.11.x branch is now inactive and no further 2.11.x releases are planned (unless unusual, unforeseeable circumstances arise). You should not target 2.11.x without asking maintainers first.

Repository structure

Most importantly:

scala/
+--build.sbt                 The main sbt build definition
+--project/                  The rest of the sbt build
+--src/                      All sources
   +---/library              Scala Standard Library
   +---/reflect              Scala Reflection
   +---/compiler             Scala Compiler
+--test/                     The Scala test suite
   +---/files                Partest tests
   +---/junit                JUnit tests
   +---/scalacheck           ScalaCheck tests
+--spec/                     The Scala language specification

but also:

scala/
   +---/library-aux          Scala Auxiliary Library, for bootstrapping and documentation purposes
   +---/interactive          Scala Interactive Compiler, for clients such as an IDE (aka Presentation Compiler)
   +---/intellij             IntelliJ project templates
   +---/manual               Scala's runner scripts "man" (manual) pages
   +---/partest              Scala's internal parallel testing framework
   +---/partest-javaagent    Partest's helper java agent
   +---/repl                 Scala REPL core
   +---/repl-frontend        Scala REPL frontend
   +---/scaladoc             Scala's documentation tool
   +---/scalap               Scala's class file decompiler
   +---/testkit              Scala's unit-testing kit
+--admin/                    Scripts for the CI jobs and releasing
+--doc/                      Additional licenses and copyrights
+--scripts/                  Scripts for the CI jobs and releasing
+--tools/                    Scripts useful for local development
+--build/                    Build products
+--dist/                     Build products
+--target/                   Build products

Get ready to contribute

Requirements

You need the following tools:

  • Java SDK. The baseline version is 8 for both 2.12.x and 2.13.x. It is almost always fine to use a later SDK such as 11 or 15 for local development. CI will verify against the baseline version.
  • sbt

MacOS and Linux work. Windows may work if you use Cygwin. Community help with keeping the build working on Windows and documenting any needed setup is appreciated.

Tools we use

We are grateful for the following OSS licenses:

Build setup

Basics

During ordinary development, a new Scala build is built by the previously released version, known as the "reference compiler" or, slangily, as "STARR" (stable reference release). Building with STARR is sufficient for most kinds of changes.

However, a full build of Scala is bootstrapped. Bootstrapping has two steps: first, build with STARR; then, build again using the freshly built compiler, leaving STARR behind. This guarantees that every Scala version can build itself.

If you change the code generation part of the Scala compiler, your changes will only show up in the bytecode of the library and compiler after a bootstrap. Our CI does a bootstrapped build.

Bootstrapping locally: To perform a bootstrap, run restarrFull within an sbt session. This will build and publish the Scala distribution to your local artifact repository and then switch sbt to use that version as its new scalaVersion. You may then revert back with reload. Note restarrFull will also write the STARR version to buildcharacter.properties so you can switch back to it with restarr without republishing. This will switch the sbt session to use the build-restarr and target-restarr directories instead of build and target, which avoids wiping out classfiles and incremental metadata. IntelliJ will continue to be configured to compile and run tests using the starr version in versions.properties.

For history on how the current scheme was arrived at, see https://groups.google.com/d/topic/scala-internals/gp5JsM1E0Fo/discussion.

Building with fatal warnings: To make warnings in the project fatal (i.e. turn them into errors), run set Global / fatalWarnings := true in sbt (replace Global with the name of a module—such as reflect—to only make warnings fatal for that module). To disable fatal warnings again, either reload sbt, or run set Global / fatalWarnings := false (again, replace Global with the name of a module if you only enabled fatal warnings for that module). CI always has fatal warnings enabled.

Using the sbt build

Once you've started an sbt session you can run one of the core commands:

  • compile compiles all sub-projects (library, reflect, compiler, scaladoc, etc)
  • scala / scalac run the REPL / compiler directly from sbt (accept options / arguments)
  • enableOptimizer reloads the build with the Scala optimizer enabled. Our releases are built this way. Enable this when working on compiler performance improvements. When the optimizer is enabled the build will be slower and incremental builds can be incorrect.
  • setupPublishCore runs enableOptimizer and configures a version number based on the current Git SHA. Often used as part of bootstrapping: sbt setupPublishCore publishLocal && sbt -Dstarr.version=<VERSION> testAll
  • dist/mkBin generates runner scripts (scala, scalac, etc) in build/quick/bin
  • dist/mkPack creates a build in the Scala distribution format in build/pack
  • junit/test runs the JUnit tests; junit/testOnly *Foo runs a subset
  • scalacheck/test runs scalacheck tests, use testOnly to run a subset
  • partest runs partest tests (accepts options, try partest --help)
  • publishLocal publishes a distribution locally (can be used as scalaVersion in other sbt projects)
    • Optionally set baseVersionSuffix := "bin-abcd123-SNAPSHOT" where abcd123 is the git hash of the revision being published. You can also use something custom like "bin-mypatch". This changes the version number from 2.13.2-SNAPSHOT to something more stable (2.13.2-bin-abcd123-SNAPSHOT).
    • Note that the -bin string marks the version binary compatible. Using it in sbt will cause the scalaBinaryVersion to be 2.13. If the version is not binary compatible, we recommend using -pre, e.g., 2.14.0-pre-abcd123-SNAPSHOT.
    • Optionally set ThisBuild / Compile / packageDoc / publishArtifact := false to skip generating / publishing API docs (speeds up the process).

If a command results in an error message like a module is not authorized to depend on itself, it may be that a global sbt plugin is causing a cyclical dependency. Try disabling global sbt plugins (perhaps by temporarily commenting them out in ~/.sbt/1.0/plugins/plugins.sbt).

Sandbox

We recommend keeping local test files in the sandbox directory which is listed in the .gitignore of the Scala repo.

Incremental compilation

Note that sbt's incremental compilation is often too coarse for the Scala compiler codebase and re-compiles too many files, resulting in long build times (check sbt#1104 for progress on that front). In the meantime you can:

  • Use IntelliJ IDEA for incremental compiles (see IDE Setup below) - its incremental compiler is a bit less conservative, but usually correct.

IDE setup

We suggest using IntelliJ IDEA (see src/intellij/README.md).

Metals may also work, but we don't yet have instructions or sample configuration for that. A pull request in this area would be exceedingly welcome. In the meantime, we are collecting guidance at scala/scala-dev#668.

In order to use IntelliJ's incremental compiler:

  • run dist/mkBin in sbt to get a build and the runner scripts in build/quick/bin
  • run "Build" - "Make Project" in IntelliJ

Now you can edit and build in IntelliJ and use the scripts (compiler, REPL) to directly test your changes. You can also run the scala, scalac and partest commands in sbt. Enable "Ant mode" (explained above) to prevent sbt's incremental compiler from re-compiling (too many) files before each partest invocation.

Coding guidelines

Our guidelines for contributing are explained in CONTRIBUTING.md. It contains useful information on our coding standards, testing, documentation, how we use git and GitHub and how to get your code reviewed.

You may also want to check out the following resources:

Scala CI

Build Status

Once you submit a PR your commits will be automatically tested by the Scala CI.

Our CI setup is always evolving. See scala/scala-dev#751 for more details on how things currently work and how we expect they might change.

If you see a spurious failure on Jenkins, you can post /rebuild as a PR comment. The scabot README lists all available commands.

If you'd like to test your patch before having everything polished for review, you can have Travis CI build your branch (make sure you have a fork and have Travis CI enabled for branch builds on it first, and then push your branch). Also feel free to submit a draft PR. In case your draft branch contains a large number of commits (that you didn't clean up / squash yet for review), consider adding [ci: last-only] to the PR title. That way only the last commit will be tested, saving some energy and CI-resources. Note that inactive draft PRs will be closed eventually, which does not mean the change is being rejected.

CI performs a compiler bootstrap. The first task, validatePublishCore, publishes a build of your commit to the temporary repository https://scala-ci.typesafe.com/artifactory/scala-pr-validation-snapshots. Note that this build is not yet bootstrapped, its bytecode is built using the current STARR. The version number is 2.13.2-bin-abcd123-SNAPSHOT where abcd123 is the commit hash. For binary incompatible builds, the version number is 2.14.0-pre-abcd123-SNAPSHOT.

You can use Scala builds in the validation repository locally by adding a resolver and specifying the corresponding scalaVersion:

$ sbt
> set resolvers += "pr" at "https://scala-ci.typesafe.com/artifactory/scala-pr-validation-snapshots/"
> set scalaVersion := "2.12.2-bin-abcd123-SNAPSHOT"
> console

"Nightly" builds

The Scala CI builds nightly download releases and publishes them to https://scala-ci.typesafe.com/artifactory/scala-integration/ .

Using a nightly build in sbt is explained in this Stack Overflow answer

Although we casually refer to these as "nightly" builds, they aren't actually built nightly, but "mergely". That is to say, a build is published for every merged PR.

Scala CI internals

The Scala CI runs as a Jenkins instance on scala-ci.typesafe.com, configured by a chef cookbook at scala/scala-jenkins-infra.

The build bot that watches PRs, triggers testing builds and applies the "reviewed" label after an LGTM comment is in the scala/scabot repo.

Community build

The Scala community build is an important method for testing Scala releases. A community build can be launched for any Scala commit, even before the commit's PR has been merged. That commit is then used to build a large number of open-source projects from source and run their test suites.

To request a community build run on your PR, just ask in a comment on the PR and a Scala team member (probably @SethTisue) will take care of it. (details)

Community builds run on the Scala Jenkins instance. The jobs are named ..-integrate-community-build. See the scala/community-builds repo.

docs.scala-lang's People

Contributors

alvinj avatar anatoliykmetyuk avatar artemkorsakov avatar b-studios avatar benluo avatar bishabosha avatar darjutak avatar dickwall avatar dongxuwang avatar dwijnand avatar eed3si9n avatar fforbeck avatar flomebul avatar fsalvi avatar heathermiller avatar i10416 avatar imsingo avatar jsuereth avatar julienrf avatar jvican avatar philippus avatar realwunan avatar santiagobasulto avatar scala-improvement-bot avatar sethtisue avatar shogowada avatar sjrd avatar som-snytt avatar travissarles avatar xeno-by avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs.scala-lang's Issues

Tutorial for Ruby programmers

Is there one in progress right now? I'm new to Scala but have written enough Ruby that I have "legacy Ruby code" out there making people cry right now. I'd like to offer my help if someone's already writing one...

Tour of Scala on mobile table of contents jumps off screen when scrolled down

When reading the Tour of Scala on an iPhone 5, and I zoom in to the content so that the actual text fills the screen, the table of contents starts out in the right position, but when I scroll down, the table of contents jumps far to the right, almost off screen. It then stays offscreen even if I try to scroll to the right to see it. Combined with #390 it is really hard to read the Tour on an iPhone.

Initial position:
2014-11-29 08 29 01

After scrolling down
2014-11-29 08 29 04

Construct the class with dynamic default value

My case class is:

case class IdentityId(userId: String, providerId: String)
case class IdentityItem (
userId:String,
providerID: String,
identityId:IdentityId)

I want to set the new initial value of identityId equal to IdentityId(userId,providerID) , This is similar to C++ initialize members of a class.
the whole code is like:

case class IdentityId(userId: String, providerId: String)
case class IdentityItem (
userId:String,
providerID: String,
identityId:IdentityId=IdentityId(userId,providerID))

Add a single-page (printable) version of the Scala Style Guide

The Scala Style Guide is an important document. At the moment it appears on many separate pages, which is great for browsing but not so good for printing out or for reading right through. It would be great if there was a single-page version available for these purposes.

I'm very happy to do the work necessary to make this happen, but I'm not sure where to start. Please can someone point me at the code that generates HTML from the .md pages in /style?

Thanks.

--KW 8-)

Adding documents translated in new language to the sidebar of the tour

I and my friend have started translating the tutorial pages in Korean.

I create copies of the original tour markdown files into /ko/tutorials/tour. But it looks like the 'language' headers I added to the markdown docs do not automatically enable the language configuration on the sidebar.

How can I create a new small tiny national flag on the sidebar of the tour? Please help me!

Title of multi-page guides

It happened that Google guided me to a page of one of the (multi-page) Scala docs guides, e.g.
http://docs.scala-lang.org/overviews/parallel-collections/performance.html

I wanted to know in which guide I landed, but actually, the title is nowhere shown (except within the URL). I think the title should be locatable with a finite number of clicks. I propose to add the title of the guide
a) in the table of contents block (instead of the title "Contents" or in addition above the title); or
b) on the first page which currently has the title "Contents".

Add a Gemfile to project

Having a Gemfile (α) in the root directory with a content as follows:

source :rubygems

gem "jekyll"
gem "RedCloth"

would make installation for users of bundler much easier.

# Installs all required gems into a local folder (β)
# Without --path it will try to install globally
$ bundle install --path=vendor/

# Run local version of jekyll 
$ bundle exec jekyll

In the long run this means less version conflicts and less binaries in $PATH.

(α) For build stability, Gemfile.lock could also be checked in. This will fix the version number of every gem.
(β) One might need to exclude vendor/ from Jekyll’s build system then.

"overview-large" docs have less-than-appealing titles

This is both in the sense of the title of the actual window as well as the title of the page. Nowhere on the page does it say the title of the actual collection of documents.

Original suggestion:

Speaking of which, do you plan on writing an index.md for the guide?
If ppl bookmark the write up it'd say "Overview - Scala Documentation"
and nowhere on the page it says Scala Parallel Collections Guide. If
not maybe include the overview name as part of the title, maybe?

Google Group for Discussion on Doc Site?

As it stands, it's not possible to subscribe to the comment feeds on docs.scala-lang. It'd be nice to explore the idea of subscribing to all or some of the posts to the site.

Clearer table of contents

Not sure if it's just me, but I spent the last few weeks frustrated by the lack of macro documentation in 2.10 until I realized today that the table of contents on the right-hand side of the page links to several other (very helpful) pages.

Is there any way to make it clearer that the reader is just looking at one page of the docs? Maybe Next and Prev links at the top and bottom?

Overview page could be better sorted

Goal: Most useful information at the top, and honour the title of "Core: The essentials"

Suggestions:

  • Move collections, futures/promises to to top
  • move reflect/macros to a new sub-section ("experimental")
  • move Scala Actor API to a new sub-section ("deprecated") (or maybe remove it altogether)

I'm not sure how to do this myself, otherwise I'd submit a PR. Any pointers, @heathermiller?

Todos section of individual document pages

Some pages in the collections overview, for example have become outdated. It's up-to-date with respect to Scala 2.8, but not Scala 2.9-- in particular, there's no mention of the Gen traits that had to be introduced due to the introduction of parallel collections in 2.9.

Collections isn't the only place where this is the case. This is also an issue on other documents as well.

For reasons like these, it'd be nice to have a "ToDos" or "this doc needs some revisions" note on the page, with a list of what needs to be done-- so committers/community can make revisions as they find them.

Tutorial for PHP developers

Similar to #275

I'm new to scala, but very well versed in PHP. I'd be happy to help with any tutorial geared towards PHP devs.

Daniel Sobral's FAQ Corner, front page

Need to make a place for Daniel to add his FAQs to.

The geoal is to have them have their own subsection on the doc-site (assuming FAQ pages keep being added). But it'd also be nice to give them a place on the front page- for example, two or three could randomly be chosen and displayed.

Tiny bug: ParArray for ParVector on parallel collections overview

Under the title "Creating a Parallel Collection" (https://github.com/scala/scala.github.com/blob/master/overviews/parallel-collections/overview.md) I think this is wrong:

import scala.collection.parallel.mutable.ParArray
val pv = new ParVector[Int]

We've two options:

import scala.collection.parallel.immutable.ParVector
val pv = new ParVector[Int]
import scala.collection.parallel.immutable.ParArray
val pa = new ParArray[Int]

What do you think?

Scala Code Style multiple import statement

What is the preferred style of multiple import statements? I didn't find any documentation about this in the style guide.

The Scala cheatsheet has this example:

import scala.collection.{Vector, Sequence}

Which also seems to be the format IntelliJ prefers but scalariform enforces the following formatting:

import scala.collection.{ Vector, Sequence }

I personally prefer the first one.

Construct the class with different constructor.

I use slick 2.0.1

My case class is:

   case class IdentityId(userId: String, providerId: String)
   case class IdentityItem (
   userId:String,
   providerID: String,
   ....
   ){
   def identityId=IdentityId(userId,providerID)
  }

userId is the foreign key of user table, providerID is the foreign key of provider table, for avoid composite primary keys, I decide add another column name identityId.

you should know that in default slick use only constructed field as the datatable column. In this case I want to use additional column "identityId".

Pattern matching in Scala for Java programmers tutorial

Hello friends,

i'm finishing the translation of this tutorial: https://github.com/scala/scala.github.com/blob/gh-pages/tutorials/scala-for-java-programmers.md

When discussing traits, the authors define this method:

override def equals(that: Any): Boolean = that.isInstanceOf[Date] && {
      val o = that.asInstanceOf[Date]
      o.day == day && o.month == month && o.year == year
}

Shouldn't be better to define the same method this way:

   override def equals(that: Any): Boolean = that match{
     case o:Date => o.day == day && o.month == month && o.year == year
     case _ => false
   }

Maybe a note can be added noting the type erasure problem.

What do you think?

quasiquotes have weird notation next to headers

There is arguably garbage around the headers in the documentation for quasiquotes. I am wondering if there is a specific reason for this or if no one ever bothered to report this and fix it.

Stray DSL note reference in style/naming-conventions.md

It's minor, but apparently there is a domain-specific language note to reference in the Parentheses section of the Naming Conventions doc:

Methods which act as accessors of any sort (either encapsulating a field
or a logical property) should be declared *without* parentheses except
if they have side effects. While Ruby and Lift use a `!` to indicate
this, the usage of parens is preferred [\#dsl\_note]\_.

I cannot trace down what doc is supposed to be linked here.

-Ron

Futures documentation missing Success/Failure import

I was working through the great documentation on futures and came across a basic issue:

:13: error: not found: value Success
f onComplete { case Success(x) => println(x); case Failure(e) => println(s"failed: $e") }

After some googling it seems a refactor moved those values to a different location. Adding this import fixes things:

scala> import scala.util.{Success, Failure}

I started to add this to the markdown docs for a pull request, but wanted to see if just adding it to the top where the other imports are mentioned is best or if someone more familiar with this change and the docs has a better suggestion?

Quickref for collection methods?

Would a quickref for collection methods be useful? I had one written down while learning the collection library where I tried to make it as compact as possible. It's mostly scala code but I had to resort to set notation for some sections and types are different too. May be too ad-hoc but putting it here as a suggestion. Maybe some alternative form can be used or quick "99 problems" examples highlighting each method.

Example can be found here.

Lines of code are miswrapped in one coding style example

The example at
http://docs.scala-lang.org/style/indentation.html#methods-with-numerous-arguments

is supposed to show when lines should be wrapped. However, lines 10 and 11 are wrapped again in my browser by the code display, and that makes the example unnecessarily hard to understand. Instead of:

val myOnerousAndLongFieldNameWithNoRealPoint = foo(someVeryLongFieldName,

you see

val myOnerousAndLongFieldNameWithNoRealPoint =
foo(someVeryLongFieldName,

If you're careful enough, you can notice that the continuation line lacks a line number, but it'd be better to avoid the wrapping.

The layout fixes the line length to which the code is wrapped — extending that would be a more invasive change. Hence it might be best to simply shorten the line.

Liquid Exception: cannot load such file -- posix_spawn_ext in sip-tutorial.md

jekyll serve fails with following error. I am using ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-linux]

Not creating a link for ref_id = "msg_unit".  Liquid Exception: cannot load such file -- posix_spawn_ext in sip-tutorial.md
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/local/share/gems/gems/posix-spawn-0.3.6/lib/posix/spawn.rb:2:in `'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/local/share/gems/gems/pygments.rb-0.5.0/lib/pygments/popen.rb:2:in `'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/local/share/gems/gems/pygments.rb-0.5.0/lib/pygments.rb:1:in `'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:55:in `require'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/tags/highlight.rb:52:in `render_pygments'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/tags/highlight.rb:45:in `render'
/usr/local/share/gems/gems/liquid-2.5.0/lib/liquid/block.rb:106:in `block in render_all'
/usr/local/share/gems/gems/liquid-2.5.0/lib/liquid/block.rb:93:in `each'
/usr/local/share/gems/gems/liquid-2.5.0/lib/liquid/block.rb:93:in `render_all'
/usr/local/share/gems/gems/liquid-2.5.0/lib/liquid/block.rb:82:in `render'
/usr/local/share/gems/gems/liquid-2.5.0/lib/liquid/template.rb:124:in `render'
/usr/local/share/gems/gems/liquid-2.5.0/lib/liquid/template.rb:132:in `render!'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/convertible.rb:77:in `render_liquid'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/convertible.rb:128:in `do_layout'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/page.rb:111:in `render'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/site.rb:235:in `block in render'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/site.rb:233:in `each'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/site.rb:233:in `render'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/site.rb:44:in `process'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/command.rb:18:in `process_site'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/commands/build.rb:23:in `build'
/usr/local/share/gems/gems/jekyll-1.0.2/lib/jekyll/commands/build.rb:7:in `process'
/usr/local/share/gems/gems/jekyll-1.0.2/bin/jekyll:59:in `block (2 levels) in '
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/command.rb:180:in `call'
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/command.rb:180:in `call'
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/command.rb:155:in `run'
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/runner.rb:402:in `run_active_command'
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/runner.rb:78:in `run!'
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/delegates.rb:7:in `run!'
/usr/local/share/gems/gems/commander-4.1.3/lib/commander/import.rb:10:in `block in '
Build Failed

External Guides Section

Would be nice if there was some place to aggregate quality external guides out there, like Twitter's Scala School, or Twitter's Effective Scala, amongst others.

This should be its own section, or be a subsection on individual pages if #36 would be implemented.

Ordering of Guides is suboptimal

The first guide listed is the architecture of Scala collections. The overview of Scala collections appears further down (and with its full index -- that's bad too). People will naturally try the first resource they find, and they assume topics further up are more entry-level than topics further down.

Refactoring, one "index" page per concept

It would be nice if concepts could each have their own central page on the site, indexing the articles and other bits of information we have about these concepts. For example, for something like implicit conversions could have a short content page introducing them (content like this could come from the Scala Tour), a section for examples, which people could contribute to, and a section connecting this concept with other related articles- implicits, for example, would have pointers to Daniel Sobral's FAQ pages on implicits.

Broken links in Scala Style Guide

On the style guide page [http://docs.scala-lang.org/style/], the link to overview [http://docs.scala-lang.org/style/overview.html] is broken. On any of the content pages, the sidebar is broken with the error:

**ERROR**. Couldn't find the total number of pages in this set of tutorial articles. Have you declared the `outof` tag in your YAML front matter? 

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.