Skip to content

Better doc strings #1222

@acampove

Description

@acampove

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:

  1. Use the IDE's lookup capabilities. In Neovim I can K on the method name, but then I see:
Image
  1. Ask chatgpt. Yeah, it is the second easiest and fastest way and I do that often.
  2. 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.
  3. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions