[mkdocs] No types or annotations for parameters
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
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.
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) : strdoes not render correctly on markdown causing missing type annotation errorannotation_*doesn't render correctly, adding "\\" renders "annotation" and adding "\\*" renders "annotation"
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from plotly/plotly.py
-
P3 size: 1 task
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug P1
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
feature P3
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
feature P3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
All issues in plotly/plotly.py
Similar issues
-
triage/confirmed
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
agentscope-ai/agentscope#2775 ·
-
comp/desktop P3 type/bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
NousResearch/hermes-agent#118866 ·
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 90/100
apache/cloudstack#14222 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100