Skip to content

bug: documentation mismatch between README and Wiki #289

Closed

Description

@lackovic

Did you check docs and existing issues?

  • I have read all the plugin docs
  • I have searched the existing issues
  • I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

NVIM v0.10.1

Operating system/version

Ubuntu 22.04.4 LTS

Describe the bug

There is one line in the README to install nvim-java (see here) while in the Wiki there are many lines (see here).

Another problem is that the README does not say where to add the line for the installation.

Steps To Reproduce

  1. open the README and read the instructions to install
  2. open the Wiki and read the instructions to install

Expected Behavior

  1. The instructions are consistent.
  2. The README says where to paste the line.

Activity

  1. s1n7ax commented on Dec 24, 2024

    @s1n7ax
    Member

    Fixed by
    #335

  2. lackovic commented on Dec 24, 2024

    @lackovic
    Author

    The instructions are consistent.

    I still see two different instructions, in the README:

    return {'nvim-java/nvim-java'}

    and in the wiki:

    return {
      'nvim-java/nvim-java',
      config = false,
      dependencies = {
        {
          'neovim/nvim-lspconfig',
          opts = {
            servers = {
              jdtls = {
                -- Your custom jdtls settings goes here
              },
            },
            setup = {
              jdtls = function()
                require('java').setup({
                  -- Your custom nvim-java configuration goes here
                })
              end,
            },
          },
        },
      },
    }

    The README says where to paste the line.

    The README does not specify where to paste the line.

  3. s1n7ax commented on Dec 24, 2024

    @s1n7ax
    Member

    @lackovic In the read me, it shows how to add nvim-java for custom setup. If you don't know where to put it, then you should learn about the package manager first. In wiki, it shows instruction for Lazyvim distribution.

  4. lackovic commented on Dec 24, 2024

    @lackovic
    Author

    @s1n7ax in your previous message you wrote that you fixed the problems I reported. I simply pointed out that you did not fix them. What did you fix?

  5. s1n7ax commented on Dec 24, 2024

    @s1n7ax
    Member

    Doesn't matter. Nothing to be fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions