Improve the frozenset.is(sub|super)set docstrings
未关闭
还没有人认领这个 Issue。
docs
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- PR 合并指标
- PR 指标待抓取
描述
Documentation
RE: Documentation provided by built-in function help()
While reviewing built-in methods in detail I made note of:
- "help(frozenset)" issubset and issuperset methods both return bool type
Other comments that were not issues
See https://github.com/python/cpython/issues/129622#issuecomment-2633394435.
- "help(slice)" third parameter typo
- "help(range)" third parameter typo
- "help(float)" quizzical hex method example
- "help(bool)" is bit_length method also for absolute value of self?
- "help(bool)" is_integer appears duck-like compatible with int (TypeError with float)
- "help(bool)" from_bytes appears to return a bool from byte array
Regards,
'EntryLevelJobSeeker'
Linked PRs
- gh-129637
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先运行 help(frozenset)，并查看 CPython 源代码中 issubset 和 issuperset 的 docstring。将它们的措辞与这些方法返回 bool 的行为进行比较；当两个 docstring 都准确描述该结果时，文档工作就完成了。关联的 PR gh-129637 表明这项工作已经在进行中。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100