Signal and OldSignal have conflated docs

Abierto
#583 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

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

Línea de trabajo

Inspecciona primero los comentarios de Moonwave y los nombres de clase en Signal.lua y OldSignal.lua. Confirma cómo se generan sus páginas de API y cómo se resuelve la redirección de OldSignal. Se considera completado cuando Signal y OldSignal tienen páginas de documentación de API separadas, y los nombres de clase documentados y la redirección se resuelven correctamente.

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

Descripción

bug

These classes share an API page as a result of a naming collision. According to their Moonwave comments, Signal.lua defines GoodSignal, and OldSignal.lua defines Signal.

However, "Signal" is the actual class/table name in both files, so their members are aggregated under Signal, and GoodSignal exists as a member-less page.

Additionally, OldSignal attempts to redirect to GoodSignal, which doesn't exist given the current file name.

Lenguaje dominante
Lua
Estrellas
632
Forks
148
Merge medio
15 h 41 min
PR fusionados (30 d)
13

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 Quenty/NevermoreEngine

Todos los issues de Quenty/NevermoreEngine

Issues similares

Más issues de Lua

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.