Skip to content

Way to avoid duplicated parameter types with docparams #8944

Open
@kasium

Description

@kasium

Current problem

Given is the following code

def foo(a: str) -> str:
  """Do something.

  Args:
    a (str): value to use
  """
  return a+a

Desired solution

I would be great to have a flag which tells docparams to detect a duplicated parameter type (given in the docs and in the signature). In sphinx if I use type hints in the signature I don't wan to duplicate them into the docstring

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Enhancement ✨Improvement to a componentNeeds PRThis issue is accepted, sufficiently specified and now needs an implementationtyping

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions