python / python/cpython

Circular dependency between `mapping` term `collections.abc.Mapping`

未關閉
#149,093 6 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
35.9k
PR 合併指標
PR 指標待擷取

描述

Documentation

The mapping (1) glossary term is defined as

A container object that supports arbitrary key lookups and implements the methods specified in the collections.abc.Mapping or collections.abc.MutableMapping abstract base classes. Examples include dict, collections.defaultdict, and collections.Counter.

Whereas for example collections.abc.Mapping(2) and collections.abc.MutableMapping(2) have the documentation:

ABCs for read-only and mutable mappings.

I expected either the documentation on a mapping or the documentation on the ABC's to describe or link to what methods a (mutable) mapping implements. Now they refer to each other in a circle for the actual specification of what methods are required.

1: https://docs.python.org/3/glossary.html#term-mapping
2: https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping

Linked PRs
  • gh-149348

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

先查看連結的 PR gh-149348,然後檢查報告中連結的 glossary mapping 項目,以及 collections.abc.Mapping 和 collections.abc.MutableMapping 文件。更新文件,描述必要的 mapping 方法,同時避免兩個項目彼此循環參照。

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

評估

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

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

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