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

Wiki page for core.completion doesn't render engine configuration option #1586

Open
2 tasks done
Ladas552 opened this issue Sep 28, 2024 · 0 comments
Open
2 tasks done
Labels
bug Issues related to bugs. Please attach a severity, a priority and category with this label.

Comments

@Ladas552
Copy link

Prerequisites

  • I am using the latest stable release of Neovim
  • I am using the latest version of the plugin

Neovim Version

NVIM v0.10.1 Build type: Release LuaJIT 2.1.1713773202 Run "nvim -V1 -v" for more info

Neorg setup

    vim.g.maplocalleader = "  "
    vim.wo.foldlevel = 99
    vim.wo.conceallevel = 2
    require("nvim-treesitter.configs").setup {
      highlight = {
        enable = true,
      }
    }
    require("neorg").setup({
      load = {
        ["core.defaults"] = {},
        ["core.concealer"] = {
          config = {
            icon_preset = "diamond",
          },
        },
        ["core.summary"] = {},
        ["core.todo-introspector"] = {},
        ["core.tangle"] = {
          config = {
            report_on_empty = false,
            tangle_on_write = true,
          },
        },
        ["core.ui.calendar"] = {},
        -- ["core.latex.renderer"] = { 
        --   config = { 
        --     render_on_enter = true, }, },
        -- ["core.integrations.image"] = {},
        ["core.esupports.metagen"] = { config = { timezone = "implicit-local", type = "empty", undojoin_updates = "false"} },
        ["core.keybinds"] = {
          config = {
            default_keybinds = true,
            neorg_leader = "<Leader><Leader>",
          },
        },
        ["core.journal"] = {
          config = {
            workspace = "journal",
            journal_folder = "/./"
          },
        },
        ["core.dirman"] = {
          config = {
            workspaces = {
              general = "~/Documents/Norg/",
              life = "~/Documents/Norg/Life/",
              work = "~/Documents/Norg/Study/",
              journal = "~/Documents/Norg/Journal/",
            },
            default_workspace = "general",
          },
        },
        -- ["core.completion"] = { config = { engine =  { module_name = "external.lsp-completion" } } },
        -- ["external.conceal-wrap"] = {},
        -- ["external.interim-ls"] = {
        --   config = {
        --     completion_provider = {
        --       -- enable/disable the completion provider. On by default.
        --       enable = true,
        --       -- Try to complete categories. Requires benlubas/neorg-se
        --       categories = false,
        --     }
        --   }
        -- },
      },
    })

Actual behavior

Wiki doesn't have a description of an option engine in the module: https://github.com/nvim-neorg/neorg/blob/main/lua/neorg/modules/core/completion/module.lua#L48

Expected behavior

That the wiki page will be generated with at least 2 definitions

Steps to reproduce

go to wiki page: https://github.com/nvim-neorg/neorg/wiki/Completion

Potentially conflicting plugins

No response

Other information

It would be nice to have every code to generate documentation above all other code in every module, not just core.completion

Help

No

Implementation help

No response

@Ladas552 Ladas552 added the bug Issues related to bugs. Please attach a severity, a priority and category with this label. label Sep 28, 2024
@github-project-automation github-project-automation bot moved this to added-updated-reopened in sorting neorg issue tracker Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues related to bugs. Please attach a severity, a priority and category with this label.
Projects
None yet
Development

No branches or pull requests

1 participant