cakephp / cakephp/cakephp-api-docs

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

Aperta
#338 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
PHP
Stelle
29
Fork
15
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla pagina di riferimento dell'API Cake\ORM\ResultSet collegata nell'issue e confrontala con il codice sorgente collegato. Traccia il modo in cui viene generato il riferimento dell'API, quindi assicurati che la classe estesa e le interfacce implementate siano visualizzate nella pagina e verifica l'output generato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
php
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.