Skip to content

[mkdocs] No types or annotations for parameters #5408

@robertclaus

Description

@robertclaus
  • Functions who include parameters in their docstring that are not explicitly written out in the function signature encounter a "Parameter '...' does not appear in the function signature" warning.
    • func(self, *args, **kwargs): all params in docstring raise warnings
  • Any parameters who do not have a type annotation (except **kwargs and any parameter in the function signature) raises a "No types or annotations for parameters ['parameter_name']"
    • engine (deprecated) : str does not render correctly on markdown causing missing type annotation error
    • annotation_* doesn't render correctly, adding "\\" renders "annotation" and adding "\\*" renders "annotation"

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1needed for current cyclebugsomething broken

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions