python / python/cpython

Clarify module.__file__ documentation in the data model reference

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

還沒有人認領這個 Issue。

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

描述

Documentation

The module.__file__ section in Doc/reference/datamodel.rst has two problems:

  • it says "Both attributes should be a str" even though the section is describing a single attribute
  • it does not clearly explain the path form readers should expect from __file__

The docs should say that __file__ is optional, should be a str when set, and is usually an absolute path for modules loaded from a file by the import system, while callers that require an absolute path should normalize it explicitly.

Linked PRs
  • gh-150273

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

開啟 Doc/reference/datamodel.rst 中的 module.file 區段,並根據 issue 的要求檢視目前的措辭。完成的標準是:文字將該屬性描述為可選,指出 str 和通常的絕對路徑行為,並說明需要絕對路徑的呼叫端應明確地將其正規化。

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

評估

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

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

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