Fix #2180: Docs update #2422

biboudis · 2017-05-12T14:32:53Z

No description provided.

dottybot

Hello, and thank you for opening this PR! 🎉

All contributors have signed the CLA, thank you! ❤️

Have an awesome day! ☀️

smarter · 2017-05-12T14:34:57Z

@felixmulder Looks like the dotty-bot disagrees with itself on whether the CLA is signed or not :)

smarter · 2017-05-12T14:38:23Z

docs/docs/contributing/intellij-idea.md

+
+If you are interested in debugging the compiler you can enable the necessary agent on the JVM and this
+is done in two steps. For the first step you need to pass the 
+necessary flag to the running VM. For convenience, this is already in comments on the `Build.scala` file under project. 


Maybe explain in more details what line to uncomment?

smarter · 2017-05-12T14:42:08Z

docs/docs/index.md


-Index
-----
 * Usage


While you're at it, could you add a link to https://github.com/lampepfl/dotty/blob/master/docs/docs/contributing/backend.md in the Contributing section of the table of content? I forgot to add it before.

There's also https://github.com/biboudis/dotty/blob/6f04a90397e80cb5c4d18ecaa66251a373ccdc3f/docs/sidebar.yml that needs to be updated

smarter · 2017-05-12T14:42:53Z

docs/docs/contributing/eclipse.md


-2. It is recommended to change the default output folder (in `Properties > java
+Assuming you have cloned dotty's repository from Github (and run `sbt managedSources` as described in 


For Eclipse, you need to run sbt ;managedSources;eclipse

This point still needs to be fixed

I added the sbt eclipse in the line below!

I don't see it?

smarter

Awesome!

biboudis · 2017-05-12T16:37:40Z

docs/docs/contributing/eclipse.md

-2. It is recommended to change the default output folder (in `Properties > java
+Assuming you have cloned dotty's repository from Github (and run `sbt managedSources` as described in 
+[Getting Started](getting-started.md)) you can now proceed to set up Dotty with Eclipse. In addition to the previous
+command you need to run `sbt eclipse` to generate the project structure for Eclipse.


ping @smarter

Ah I see now, thanks. But I would prefer to not leave this critical command inside a line of text, I think it'd be better to have it in a real code block.

Basically something like:

1. Follow the instructions in the [Getting Started](...) page 2. Generate the Eclipse configuration files: ``` sbt eclipse ```

felixmulder

Excellent job! We have real docs now! 🎉

felixmulder · 2017-05-14T16:01:00Z

docs/docs/contributing/eclipse.md

+2. Generate the Eclipse configuration files:
+```
+sbt eclipse
+```


This one doesn't have the nice ```shell and $ as your previous snippets (=

felixmulder · 2017-05-14T16:03:19Z

docs/docs/contributing/intellij-idea.md


-1. Open New Project dialog and select `Scala` > `Dotty`
-2. Proceed as usual and don't forget to create or select Dotty SDK.
+Assuming you have cloned dotty's repository from Github (and run `sbt managedSources` as described in [Getting Started](getting-started.md))


, at the end of this line for inner voice to be able to take a breath.

felixmulder · 2017-05-14T16:08:48Z

docs/docs/contributing/testing.md

 ```

-You can further restrict the executed tests to a subset of `TestClass` methods
-as follows:
+To run a single test class you use `testOnly` and the fully qualified class name. 


Actually, you can do:

> testOnly -- *targetFunction

to run all tests named targetFunction, in any class.

You can also do:

> testOnly *.MyTargetClass

to run all paths with a class named MyTargetClass. Both sides are regexes, so you should be able to do:

> testOnly * -- *

which would be the same as test.

felixmulder · 2017-05-14T16:10:12Z

docs/docs/contributing/testing.md

-> partest-only-no-bootstrap
-> partest-only
-> partest
+> dotty-compiler/testOnly dotty.tools.dotc.transform.TreeTransformerTest -- *canOverwrite


This could be written shorter as: testOnly *.TreeTransformerTest -- *canOverride, but I guess it's good to be consequential to what you decided to do WRT the above comment :)

felixmulder · 2017-05-14T16:10:50Z

docs/docs/contributing/testing.md

- reuses the same VM for compilation
- allows filtering of tests
- runs much faster (almost 2x)
+All of these tests are contained in the `./tests/*` directories.

 Currently to run these tests you need to invoke from sbt:

 ```bash
 > testOnly dotty.tools.dotc.CompilationTests


this is aliased as: vulpix without args.

felixmulder · 2017-05-14T16:11:28Z

docs/docs/contributing/workflow.md

@@ -78,7 +50,7 @@ scala> import dotty.tools.DottyTypeStealer._; import dotty.tools.dotc.core._; im

 Now, you can define types and access their representation. For example:

-```scala
+```bash


I'm pretty sure this was to get nicer syntax-highlighting. But I'm not sure I'm the one who wrote it..

felixmulder · 2017-05-15T07:04:02Z

@biboudis: the bot could not verify your CLA signature. I checked it manually, and it looks like you haven't signed: https://www.lightbend.com/contribute/cla/scala/check/biboudis

Please sign: https://www.lightbend.com/contribute/cla/scala

biboudis added 2 commits May 10, 2017 18:30

Update IDEA and talks

6e46455

Improve Eclipse documentation, workflow and testing

796222c

biboudis requested review from smarter and felixmulder May 12, 2017 14:32

dottybot reviewed May 12, 2017

View reviewed changes

smarter reviewed May 12, 2017

View reviewed changes

smarter approved these changes May 12, 2017

View reviewed changes

biboudis added 3 commits May 12, 2017 17:00

Improve Eclipse/IDEA pages

6f04a90

Update sidebar

f769faa

Add some minor stylistic aspects

2024307

biboudis commented May 12, 2017

View reviewed changes

Make sbt eclipse command clearer

36d96f8

felixmulder reviewed May 14, 2017

View reviewed changes

Adjust command prompts and improve description of testOnly syntax

0acf3ba

felixmulder merged commit c6a2a3f into scala:master May 15, 2017


		2. It is recommended to change the default output folder (in `Properties > java
		Assuming you have cloned dotty's repository from Github (and run `sbt managedSources` as described in

Fix #2180: Docs update #2422

Fix #2180: Docs update #2422

Uh oh!

Conversation

biboudis commented May 12, 2017

Uh oh!

dottybot left a comment

Choose a reason for hiding this comment

Uh oh!

smarter commented May 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smarter left a comment

Choose a reason for hiding this comment

Uh oh!

biboudis May 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

felixmulder left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

felixmulder commented May 15, 2017

Uh oh!

Uh oh!

biboudis May 12, 2017 •

edited

Loading