enchant_broker_*: document the ValueError and fix the return types
维护者通常 1 天内回复
已经有一个关联 PR 被合并了。
- #5989 来自 @qodelicious —— 已合并
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 82/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- php, xml
调研方向
从 reference/enchant/functions/enchant-broker-*.xml 页面开始，将其返回类型和错误说明与 #5935 中相关的 enchant_dict_* 页面进行比较。记录所述的 ValueError 和 Error 情况，包括 tag 为空的情况，并将返回类型更新为 EnchantBroker 和 EnchantDictionary；这些页面准确描述异常和返回类型后即完成。
由索引模型根据 Issue 内容生成。
描述
Affected page
reference/enchant/functions/enchant-broker-*.xml
Current issue
The enchant_broker_* pages don't document the ValueError thrown for an unusable EnchantBroker (new EnchantBroker(), or after enchant_broker_free()). enchant_broker_init, enchant_broker_request_dict and enchant_broker_request_pwl_dict still describe a resource as return value.
Suggested improvement
Add an errors section (ValueError for an invalid broker, plus the Error of enchant_broker_free with open dictionaries and the empty tag cases), and return EnchantBroker / EnchantDictionary instances.
Additional context (optional)
Same as #5935 for enchant_dict_*. Checked on PHP 8.4 and 8.5.
- 主要语言
- XML
- 星标
- 602
- 派生
- 904
- 平均合并
- 1 天 6 小时
- 30 天内合并 PR
- 93
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
php/doc-en 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复
-
SID is deprecated可能已有人在做 @jordikroon 于 11 天前认领。 未关闭bug
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
Files still using &warn.undocumented.func;可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭help wanted
难度 2/5 1-3 小时 新手友好度 68/100
php/doc-en#5786 · 1 个 reaction ·
维护者通常 1 天内回复
-
bug
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
8.6 Extension: mysqli
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
Lakr233/vphone-cli#738 ·
维护者通常 1 天内回复
-
[ordering-review] workshop order graph: 1 confirmed ordering problem, 3 cycles are false positives未关闭
难度 2/5 1-3 小时 新手友好度 78/100
githubnext/gh-aw-workshop#4943 ·
维护者通常 1 天内回复
-
Awaiting Triage
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100