Skip to content

[Feature Request] Regenerate docstring with docstring commands #302

@Gauraviitkgp

Description

@Gauraviitkgp

What

Docstring should be regenerated when the function arguments are updated. For example

    def search(self, request:model.Request, k=2) -> list[model.Response]:
        """Searchs for vectors closest to the request

        Args:
            request (model.Request): Request with neccessary information to find the closest vectors
            k (int, optional): Number of search results. Defaults to 2.
            

        Returns:
            list[model.Response]: Results
        """

Now if I add a new kwarg

    def search(self, request:model.Request, k=2, fetch_k=20) -> list[model.Response]:
        """Searchs for vectors closest to the request

        Args:
            request (model.Request): Request with neccessary information to find the closest vectors
            k (int, optional): Number of search results. Defaults to 2.
            

        Returns:
            list[model.Response]: Results
        """

I feel re-running the extension should add fetch_k in the args.

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