matplotlib / matplotlib/matplotlib.github.com

Canonicalization for 're'-inherited methods

未关闭
#60 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
没有语言数据
星标
29
派生
62
PR 合并指标
30 天内没有已合并 PR

描述

In 3.4.0, the docs for some `Axes` methods (`pick`, `pickable`, `get_picker`, `set_picker`, `get_contains`, `set_contains`) were removed. This is because the docs are inherited from the `Artist` methods.

Sphinx automatically switches all references when generated the docs, but our redirect/canonicalization script here doesn't recognize it. Instead, it thinks these methods were last documented in 3.3.4 and points there.

We should decide if we want to point to the new location (and figure out if it's possible), and do so.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

调研方向

首先定位重定向/规范化脚本,并将其对继承的 Artist 方法的处理方式与 Sphinx 生成的引用进行比较。检查在 3.4.0 移除文档后,Axes 方法是如何表示的。当脚本将这些方法指向其当前的规范位置,或明确记录这是不可能的时,即可视为完成。

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

评估

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

把新 issue 发到你的邮箱

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