plotly / plotly/plotly.py

[mkdocs] No types or annotations for parameters

Open
#5,408 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P1
Dominant language
Python
Stars
18.8k
Forks
2.8k
Avg merge
16h 26m
Merged PRs (30d)
21

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the documented *args/**kwargs, deprecated engine, and annotation_* cases in the MkDocs documentation rendering path. Trace how parameter names and annotations are parsed and rendered, then verify that valid parameters no longer produce warnings and that their types display correctly in Markdown.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.