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.

Sign up for GitHub

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

Jump to bottom

generate root_dir docs from source code #2011

Open
justinmk opened this issue Jul 17, 2022 · 1 comment · May be fixed by #2237
Open

generate root_dir docs from source code #2011

justinmk opened this issue Jul 17, 2022 · 1 comment · May be fixed by #2237
Labels
enhancement New feature or request

Comments

@justinmk
Copy link
Member

justinmk commented Jul 17, 2022 •
edited

Problem

#1742 reported that the generated docs for root_dir are sometimes invalid.
The response was 9dc0249
which just removed the generation:
733fe92

Besides being cumbersome, the manual documentation leads to problems like: #2006

Solution

  1. Restore the generation the code removed in 9dc0249 and...
    1. make it link to the source instead of trying to parse it (e.g. [path/to/foo.lua](https://github.com/neovim/nvim-lspconfig/blob/…/foo.lua#L132-L149))
    2. or just fix the parsing.
  2. Use treesitter to parse the file?
@justinmk justinmk added the enhancement New feature or request label Jul 17, 2022
This was referenced Jul 17, 2022
Closed
Merged
@sersorrel
Copy link

this would also fix e.g. rnix's docs saying that root_dir defaults to "vim's starting directory" when in fact it's util.find_git_ancestor(fname) or vim.loop.os_homedir(), which is very much not the same thing

@kylo252 kylo252 linked a pull request Nov 9, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: export workspace markers kylo252/nvim-lspconfig
2 participants
@justinmk @sersorrel