Is your feature request related to a problem? Please describe.
In places like this I do not see any docstring. Not all methods should have a docstring, but this method is public and often needed. I can check what the method does by:
- Use the IDE's lookup capabilities. In Neovim I can
K on the method name, but then I see:
- Ask chatgpt. Yeah, it is the second easiest and fastest way and I do that often.
- Have my own notes for most used functionality. It means I have to write notes and then go and search the. Takes too much time and effort.
- Read the official documentation. It also takes effort and interferes with the user's worflow.
So, ideally, there should be a docstring for these methods to quickly check that they do what we think it does.
Describe the solution you'd like
I would add docstrings
Is your feature request related to a problem? Please describe.
In places like this I do not see any docstring. Not all methods should have a docstring, but this method is public and often needed. I can check what the method does by:
Kon the method name, but then I see:So, ideally, there should be a docstring for these methods to quickly check that they do what we think it does.
Describe the solution you'd like
I would add docstrings