plotly.py icon indicating copy to clipboard operation
plotly.py copied to clipboard

[mkdocs] No types or annotations for parameters

Open robertclaus opened this issue 1 month ago • 0 comments

  • 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"

robertclaus avatar Nov 07 '25 17:11 robertclaus