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

confusing documentation about sbt axises #70

Closed
antonkulaga opened this issue Nov 17, 2014 · 3 comments
Closed

confusing documentation about sbt axises #70

antonkulaga opened this issue Nov 17, 2014 · 3 comments

Comments

@antonkulaga
Copy link

here http://www.scala-sbt.org/0.13.5/docs/Getting-Started/Scopes.html some descriptions are very confusing.

In particular it took me long time to undestand that in

{<build-uri>}<project-id>/config:intask::key

I should choose between config or intask and then add ::key
I think one or two examples like:

fooproject/config::name
fooproject/intask::bartask

will resolve the problem.
In my case confusing parts appeared because I got used to the notion that I operate with sbt as if I operate with scala-code. But in case of project/axis::key notation I operate just with some sbt-specific command syntax that is not code. I think it should be highlighted in the beginning that we are dealing with some special notation and axises here do not mean some scala traits (like I thought in the beginning) but a part of sbt console commands.

@eed3si9n
Copy link
Member

Thanks for the suggestion. Adding more examples make sense.

You're right that it is quirkiness. I've personally wanted to unify towards Scala notation even if it's more typing.

@jsuereth
Copy link
Member

Yeah.... I think eventually we may want to parse, equally, "foo in (bar, baz, booz)" so that the two are uniform....

@eed3si9n
Copy link
Member

Closing this for now.
https://www.scala-sbt.org/1.x/docs/Scopes.html hopefully has improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants