cakephp / cakephp/cakephp-api-docs

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

Ouverte
#338 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement
Langage dominant
PHP
Étoiles
29
Forks
15
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la page de référence de l’API Cake\ORM\ResultSet liée dans l’issue et comparez-la au code source lié. Suivez la manière dont la référence de l’API est générée, puis assurez-vous que la classe étendue et les interfaces implémentées sont affichées sur la page et vérifiez la sortie générée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
php
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.