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 documentation for builtin lsp symbols #2365

Merged
merged 2 commits into from
Feb 19, 2023

Conversation

uraza
Copy link
Contributor

@uraza uraza commented Feb 3, 2023

Add missing documentation for symbol_width and symbol_type_width on lsp_document_symbols and lsp_workspace_symbols.

Description

Documentation for symbol_width and symbol_type_width was missing for telescope.builtin.lsp_document_symbols and telescope.builtin.lsp_workspace_symbols.

Type of change

Documentation update.

How Has This Been Tested?

Opening a draft pull request to check the updated documentation.

Configuration:

  • Neovim version (nvim --version): NVIM v0.8.2
  • Operating system and version: CentOS 7

Checklist:

  • My code follows the style guidelines of this project (stylua)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (lua annotations)

Add missing documentation for symbol_width and symbol_type_width on lsp_document_symbols and lsp_workspace_symbols.
@Conni2461
Copy link
Member

why is this a draft?

@uraza
Copy link
Contributor Author

uraza commented Feb 19, 2023

why is this a draft?

Hi.
As this was a documentation update, I followed the steps here which suggested to create a draft PR to let the CI generate the documentation and then review it before doing an "official" PR: https://github.com/nvim-telescope/telescope.nvim/blob/master/CONTRIBUTING.md#auto-updates-from-ci

@Conni2461 Conni2461 marked this pull request as ready for review February 19, 2023 10:10
@Conni2461
Copy link
Member

I need to update this. thanks for pointing it out

@Conni2461
Copy link
Member

also docgen doesnt sometimes run, which is unfortunate ^^

thanks for the PR :)

@Conni2461 Conni2461 merged commit 5ce991a into nvim-telescope:master Feb 19, 2023
Conni2461 pushed a commit that referenced this pull request Feb 19, 2023
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

2 participants