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.

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

Jump to bottom

Code sample fixes #114

Closed
wants to merge 1 commit into from
Closed

Code sample fixes #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/tutorial/11-Custom-Settings.md
View file
Open in desktop
Expand Up @@ -32,12 +32,12 @@ Keys have one of three types. `SettingKey` and `TaskKey` are described in
Some examples from [Keys](../sxr/sbt/Keys.scala.html):

```scala
val scalaVersion = settingKey[String]("The version of Scala used for building.")
val clean = taskKey[Unit]("Deletes files produced by the build, such as generated sources, compiled classes, and task caches.")
val scalaVersion = settingKey[String]("scala-version", "The version of Scala used for building.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous code is still the conceptual constructor. We would have it be exactly that if we weren't maintaining compatibility w/ 0.12 build scripts.

val clean = taskKey[Unit]("clean", "Deletes files produced by the build, such as generated sources, compiled classes, and task caches.")
```

The key constructors have two string parameters: the name of the key
(`"scalaVersion"`) and a documentation string
(`"scala-version"`) and a documentation string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, in sbt 0.13 we create a "backwards compatible mode" for camel-case vs. '-'. IN all of sbt, the string scala-version CAN be used, but wont' show up in help documentation. Yes the code still has the backwards compatible name. I think perhaps we need to clarify.

(`"The version of scala used for building."`).

Remember from [.sbt build definition][Basic-Def] that the type
Expand Down