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

Abierto
#338 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php
Área
documentation

Línea de trabajo

Comienza con la página de referencia de la API de Cake\ORM\ResultSet enlazada en el issue y compárala con el código fuente enlazado. Traza cómo se genera la referencia de la API y, después, asegúrate de que la clase extendida y las interfaces implementadas se muestren en la página y verifica la salida generada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement
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

Lenguaje dominante
PHP
Estrellas
29
Forks
15
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de cakephp/cakephp-api-docs

Todos los issues de cakephp/cakephp-api-docs

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.