python / python/cpython

Improve the frozenset.is(sub|super)set docstrings

未關閉
#129,622 10 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
35.9k
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

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先執行 help(frozenset),並檢視 CPython 原始碼中的 issubset 和 issuperset docstring。將它們的措辭與這些方法回傳 bool 的行為進行比較;當兩個 docstring 都準確描述該結果時,文件工作就完成了。連結的 PR gh-129637 表示這項工作已經在進行中。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。