box types not named consistently
还没有人认领这个 Issue。
评估
调研方向
首先检查现有的 Box 类型定义及其文档中记录的类型参数。该 issue 提议使用形容词-名词形式的名称、为旧名称提供已弃用的别名，并可能对 Box 进行子类化，但首选设计尚未确定。完成该任务需要先由 maintainer 做出决定，然后进行相应的 API 和文档更改。
由索引模型根据 Issue 内容生成。
描述
I always prefer class/type naming to be "adjective noun" as opposed to "noun adjective", which some prefer because filenames group together. "Adjective noun" matches normal speech, such as "hand me the blue pen".
When I first looked at box types I had to take time to understand what they meant, because my first reaction what "what is different to name one camel_killer_box and another box_dots".
I suggest that names be change to:
- conversion_box
- default_box
- dots_box
- camel_killer_box
- frozen_box
- recast_box
- intact_types_box
and allow previous names as synonyms for a time, marked with a deprecated warning.
However, I wonder why you didn't subclass box instead. You are calling the above type arguments.
Sub-classing Box would also have the benefit of
- making it more explicit that it is a different type with some additional behavior
- allow parameters specific to the sub-class to be specific to the init for that class
- it is clear from the documentation that supplemental box arguments are specific to the type of box
Would you accept a pull request for this?
- 主要语言
- Python
- 星标
- 2.8k
- 派生
- 145
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
cdgriffith/Box 的其他 Issue
-
subclass of `Box` does not unpickle correctly可能已有人在做 @koriyoshi2041 于 145 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 70/100
cdgriffith/Box#308 ·
-
难度 3/5 1-2 天 新手友好度 42/100
cdgriffith/Box#307 · 1 条评论 ·
-
Dotted keys read from YAML are lost with box_dots / default_box可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 3/5 1-2 天 新手友好度 48/100
cdgriffith/Box#305 ·
-
[Bug] Camel killer box and box dots gives unexpected behaviour可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 3/5 1-2 天 新手友好度 30/100
cdgriffith/Box#300 ·
-
难度 3/5 1-2 天 新手友好度 42/100
cdgriffith/Box#298 ·
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 66/100
-
[Bug]: Queen's own Ollama model loses num_ctx when a running session switches to it可能已有人在做 @anasamin26 今天认领。 未关闭bug enhancement
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
llm translation
难度 2/5 1-3 小时 新手友好度 78/100
BerriAI/litellm#47884 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug 🐛
难度 2/5 1-3 小时 新手友好度 72/100
netalertx/NetAlertX#1856 · 1 个 reaction ·
维护者通常 1 天内回复