Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add support for parsing docs for single constants

Abierto
#204 1 comentario 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
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php
Área
documentation, tooling

Línea de trabajo

Comienza con PR #203 y la ruta existente del parser para el manejo de constantes. Comprueba cómo el PR integra las constantes en un post type y recupera su documentación; terminado significa que las descripciones se almacenan, mientras que la edición y la compatibilidad de visualización de post type quedan fuera del alcance. Ten en cuenta que phpDocumentor todavía no admite DocBlock templates.

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

Descripción

enhancement has PR

The parser already technically supports parsing constants, but the attached PR hooks them up to a new post type and retrieves the associated documentation. We can add post type / editing / display support at a later time in the wporg-developer theme, but it would be nice to be actually storing the descriptions somewhere.

PR: #203

It should be noted that parsing DocBlock template support is not yet available in phpDocumentor, which means core WordPress is kind of out of luck with the current state of constants documented in wp-config.php. Templates are the ability to document multiple elements at the same time, e.g.

/**#@+
 * DocBlock Template example: One summary for all.
 *
 * One description for all.
 *
 * @since 2.6.0
 */
define('AUTH_KEY',         '...');
define('SECURE_AUTH_KEY',  '...');
define('LOGGED_IN_KEY',    '...');
define('NONCE_KEY',        '...');
define('AUTH_SALT',        '...');
define('SECURE_AUTH_SALT', '...');
define('LOGGED_IN_SALT',   '...');
define('NONCE_SALT',       '...');

/**#@-*/
Lenguaje dominante
PHP
Estrellas
239
Forks
81
Merge medio
16 h 29 min
PR fusionados (30 d)
8

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 WordPress/phpdoc-parser

Todos los issues de WordPress/phpdoc-parser

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.