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

Update info in README about out-of-the box support in Vim #330

Closed
waldyrious opened this issue Aug 24, 2024 · 4 comments
Closed

Update info in README about out-of-the box support in Vim #330

waldyrious opened this issue Aug 24, 2024 · 4 comments

Comments

@waldyrious
Copy link

The README currently says:

  • Vim:
    • via ale - will support Marksman out-of-the-box once PR is merged; in the meantime...

      Example config (add the following to your ~/.vim/after/ftplugin/markdown.vim):

      if exists('g:loaded_ale')
        call ale#linter#Define('markdown', { 'name': 'marksman', 'lsp': 'stdio', 'executable': 'marksman', 'command': '%e server', 'initialization_options': {} })
      end

Since the mentioned PR dense-analysis/ale#4565 has been merged, shouldn't this section of the README be updated?

@artempyanykh
Copy link
Owner

Thanks for raising this @waldyrious! I'd be happy to accept README fixes in a PR :)

@waldyrious
Copy link
Author

waldyrious commented Sep 3, 2024

I'd be happy to submit a PR, but as I'm not a Vim user, I'm not really sure what it should say instead 😅 — can it just be as follows?

  • Vim:
    • via ale - supports Marksman out-of-the-box

I noticed that a new version of ale has not yet been released with that change, so I'm not sure this is really accurate 🤔

@artempyanykh
Copy link
Owner

@waldyrious ack! Perhaps this is for the future then. I'll close the issue for now.

@waldyrious
Copy link
Author

waldyrious commented Sep 18, 2024

Maybe the README could still be changed from "once PR 4565 is merged" to "once the changes from PR 4565 are released", or something like that. Otherwise, it seems confusing since the PR is already merged. WDYT? I can submit a PR with that change if you agree.

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

2 participants