cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 29
- Forks
- 15
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Vergleiche die generierte API-Seite für RecordNotFoundException mit der Quellreferenz in CakeException.php, insbesondere den Text {@link \Cake\Http\Response::withHeader()}. Verfolge den für die Konvertierung dieser Referenzen verantwortlichen Docs-Builder oder Link-Generator und überprüfe anschließend, dass die generierte API-Dokumentation sie als Hyperlinks statt als rohe Zeichenketten rendert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100