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 摘要。