plotly / plotly/plotly.py

[mkdocs] No types or annotations for parameters

未关闭
#5,408 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

bug P1
主要语言
Python
星标
18.8k
派生
2.8k
平均合并
16 小时 26 分钟
30 天内合并 PR
21

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,在 MkDocs 文档渲染路径中重现文档所述的 *args/**kwargs、已弃用的 engineannotation_* 情况。跟踪参数名称和注解的解析与渲染方式,然后验证有效参数不再产生警告,并且其类型能在 Markdown 中正确显示。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。