python / python/docs-community

ABC documentation needs more details on usage

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

还没有人认领这个 Issue。

question
主要语言
Makefile
星标
55
派生
26
PR 合并指标
30 天内没有已合并 PR

描述

I am trying to use Abstract Base Classes. But I find the documentation lacking on several points that makes the matter too 'abstract'.

For example. There is no explanation on making abstract objects mandatory by using exceptions

Or how to implement Iterable abstract bsse class that can be inherited from and still be usable.

Can someone shed more light onto this so that the documentation is more accessible?

贡献指南

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

从这里开始

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

调研方向

首先定位 Abstract Base Classes 文档,并检查其目前对抽象对象、异常和 Iterable 继承的覆盖情况。完成的标准是文档清楚地解释所请求的使用模式,并使示例对读者更易理解;issue 中没有指定具体的文件或测试。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

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