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

chore: add type annotations #2856

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

chore: add type annotations #2856

wants to merge 2 commits into from

Conversation

jamestrew
Copy link
Contributor

trying something out.
I like types and I think it can help with our documentation deficiencies as well (eg. confusions around why you can pass default_text to find_files and why it's not documented, where to document it, etc, but this might need some enhancements to tree-sitter-lua since the newer luals luacats annotation support is limited).

--- Picker is the main UI that shows up to interact w/ your results.
-- Takes a filter & a previewer
---@class TelescopeBasePicker
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this feels pretty ridiculous lol

Parameters: ~
{opts} (table) options to pass to the picker
TelescopeLiveGrepOpts *TelescopeLiveGrepOpts*
TelescopeBasePickerOpts
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't like this

@jamestrew
Copy link
Contributor Author

@Conni2461 what do you think?

@Conni2461
Copy link
Member

i guess we can do that. i havent made up my mind regarding lua language servers annotations. they aren't compatible with emmylua annotations which are used within docgen (its uses a lua treesitter parser with emmylua support).

fyi there is also this: #1954

@jamestrew
Copy link
Contributor Author

they aren't compatible with emmylua annotations which are used within docgen (its uses a lua treesitter parser with emmylua support).

Yeah I actually made an issue on tree-sitter-lua about (me) potentially adding or converting the ts grammar to support luals annotations.

I know this is something neovim core eventually would like for their docgen purposes as well. Somebody just needs to do it.

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