python / python/devguide

Test coverage c extension doc fix

未關閉
#593 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

topic-test type-bug
主要語言
Python
星號
2.1k
分支
1k
平均合併
2 天 12 小時
30 天內合併 PR
12

描述

Currently in the test coverage section, specifically 5.2.1.4, it mentions building the C extension for coverage.py. For a while now coverage.py has come with the C extension by default, so this step is almost never required (see here: https://coverage.readthedocs.io/en/coverage-5.1/install.html#c-extension).
I'm thinking it would be worth mentioning in the guide that installing the C extension is only required if 'coverage --version' says 'Without C extension'.

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

從測試涵蓋率部分開始,具體查看小節 5.2.1.4,並將其中關於 C 擴充功能的說明與連結的 coverage.py 文件進行比較。當指南說明只有在 coverage --version 回報 “Without C extension” 時才需要安裝該擴充功能,即表示完成。

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

評估

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

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

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