change doc to recommend metals worksheet #12874
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bishabosha
force-pushed
the
docs-remove-worksheet
branch
from
0354bd4 to
7d625e1
Compare
|
Seems like we could just delete that page and point to the metals documentation which will always be more up to date |
tgodzik
requested changes
Jun 18, 2021
There was a problem hiding this comment.
@smarter might be right that Metals worksheet docs should be always more up to date. Is the current state of the docs enough though? https://scalameta.org/metals/docs/editors/vscode.html#worksheets
| A worksheet is a Scala file that is evaluated on save, and the result of each | ||
| expression is shown in a column to the right of your program. Worksheets are | ||
| A worksheet is a Scala file that is evaluated on save, powered | ||
| by [Scala Metals](https://scalameta.org/metals/), and the result of each |
There was a problem hiding this comment.
Suggested change
| by [Scala Metals](https://scalameta.org/metals/), and the result of each | |
| by [Scala Metals](https://scalameta.org/metals/) and [mdoc](https://scalameta.org/mdoc/), and the result of each |
| @@ -24,27 +25,20 @@ println("Hello, worksheets!") | |||
| 456 + xyz | |||
| ``` | |||
|
|
|||
| On top of the buffer, the message `Run this worksheet` appears. Click it to | |||
| evaluate the code of the worksheet. Each line of output is printed on the right | |||
| On top of the buffer, the message `Copy Worksheet Output` appears. Save the file to evaluate the code of the worksheet. Each line of output is printed on the right | |||
There was a problem hiding this comment.
I wouldn't mention Copy Worksheet Output here, it can be mentioned additionally.
|
I will close do to the other rewrite being proposed by scala/docs.scala-lang#2112 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.