cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
オープン
まだ誰も着手していません。
- 主要言語
- PHP
- スター
- 29
- フォーク
- 15
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Description
Viewing API Documentation on the web, e.g. RecordNotFoundException, shows the raw link string instead of an actual hyperlink, e.g.:
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
It doesn't seem that the files containing the links are the issue, e.g. CakeException.php hasn't changed in ~two years, perhaps the docs builder/link generator has started failing?
CakePHP Version
4.4.0
PHP Version
No response
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
生成された RecordNotFoundException API ページを CakeException.php のソース参照と比較し、特に {@link \Cake\Http\Response::withHeader()} のテキストを確認してください。これらの参照を変換する役割を担う docs builder または link generator を追跡し、生成された API ドキュメントでそれらが生の文字列ではなくハイパーリンクとしてレンダリングされることを検証してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- php
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100