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

Add missing docs and move versions to a more prominent location. #1934

Merged
merged 1 commit into from Jul 21, 2020

Conversation

tgodzik
Copy link
Contributor

@tgodzik tgodzik commented Jul 20, 2020

This PR adds the following:

  • new Scala project documentation for vim and VS Code
  • parent code lenses documentation for vim and VS Code
  • fixes a number of smaller issues
  • moves versions to a more prominent location

@tgodzik tgodzik requested a review from ckipp01 July 20, 2020 13:02
docs/editors/new-editor.md Show resolved Hide resolved
docs/editors/overview.md Show resolved Hide resolved

Whenever text is paste into a multiline string with `|` it will be properly
formatted by Metals:

![format-on-paste](https://i.imgur.com/yJLAIxQ.gif)
![format-on-paste](https://i.imgur.com/fF0XWYC.gif)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added better gifs, because the previous ones were bother me quite a bit 😅

docs/editors/overview.md Show resolved Hide resolved
Comment on lines 9 to 11
All editors use a separate Metals server underneath, which version can be
changed idependently. It can be used to checkout newest features from the main
branch.
Copy link
Member

Choose a reason for hiding this comment

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

In theory though, this could change moving forward no? Now that everything can be configured via InitializationOptions, there is no need to have a metals-vscode and metals-emacs but a single metals for each desired version.

Copy link
Contributor Author

@tgodzik tgodzik Jul 20, 2020

Choose a reason for hiding this comment

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

Hmm... right. Maybe then I will just remove the section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved the lower paragraph here.

@@ -323,7 +323,7 @@ Then, when on the line that you'd like to expand the decoration to get the hover

coc-metals has a built-in implementation of the [Tree View
Protocol](https://scalameta.org/metals/docs/editors/tree-view-protocol.html).
If you have the [recommended mappings](coc-mappings.vim) copied, you'll notice
If you have the [recommended mappings](vim.md#recommended-cocnvim-mappings) copied, you'll notice
Copy link
Member

Choose a reason for hiding this comment

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

Just out of curiosity, since it's the same page this doesn't need to be prefaced with vim.md right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ach, right. I will remove it. I never remember the exact syntax needed, so I experiment a bit.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, I am getting a warning without it, so I will leave it as is.

@@ -411,6 +411,14 @@ install [coc-json](https://github.com/neoclide/coc-json).
```scala mdoc:user-config:lsp-config-coc
```

```scala mdoc:parent-lenses:vim
Copy link
Member

Choose a reason for hiding this comment

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

I actually have a whole section on this further down. https://scalameta.org/metals/docs/editors/vim.html#goto-super-method

I'd say remove it and replace it with this, but then my readme and this document becomes quite a bit different. I don't love having them both, but I also don't like not having a detailed readme 🤔 I'm not really sure what would be best for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Haven't noticed it. I can just add it to the VS Code section then.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed from vim section.

metals-docs/src/main/scala/docs/NewProjectModifier.scala Outdated Show resolved Hide resolved
metals-docs/src/main/scala/docs/NewProjectModifier.scala Outdated Show resolved Hide resolved
Copy link
Member

@ckipp01 ckipp01 left a comment

Choose a reason for hiding this comment

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

Looks like you still need a scalafix run, but other than that LGTM!

…t lenses. Also, move versions table to a more prominent location
@tgodzik tgodzik merged commit 967c621 into scalameta:main Jul 21, 2020
@tgodzik tgodzik deleted the fix-docs branch July 21, 2020 11:59
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

Successfully merging this pull request may close these issues.

None yet

3 participants