cakephp / cakephp/cakephp-api-docs

Web site API reference lacks extended class and implemented interfaces...

未关闭
#338 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement
主要语言
PHP
星标
29
派生
15
PR 合并指标
30 天内没有已合并 PR

描述

Description

I feel strange because I can't believe I can't find it...

I pick up just an example. I was trying to understand what Cake\ORM\ResultSet actually is. Easy to guess by the scope and the name (and the methods). But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations. For CakePHP I have to open the source code link.

Example: Cake\ORM\ResultSet.

CakePHP Version

5.2

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 issue 中链接的 Cake\ORM\ResultSet API 参考页面开始,并将其与链接的源代码进行比较。跟踪 API 参考的生成方式,然后确保扩展的类和实现的接口显示在页面上,并验证生成的输出。

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

评估

技术栈
php
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

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