ipython / ipython/traitlets

Document `TraitType.read_only`

未关闭 适合新手
#410 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation
主要语言
Python
星标
653
派生
217
平均合并
2 天 21 小时
30 天内合并 PR
2

描述

By searching the repo, I was able to find this description in the changelog:

> Trait attributes initialized with read_only=True can only be set with the set_trait method. Attempts to directly modify a read-only trait attribute raises a TraitError.

This description would be nice to have in docs/docstrings!

贡献指南

打开贡献指南

调研方向

在仓库中搜索 TraitType.read_only 和 changelog 描述,然后检查相关的 docs 或 docstrings。记录只读 trait 属性只能通过 set_trait 设置,直接修改会引发 TraitError;当 TraitType 的文档中涵盖了这一行为时即完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
65/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。