Empty enums generate error

Abierto
#71 0 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
38/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
cpp, jekyll

Línea de trabajo

Comienza reproduciendo el problema con el enum vacío en options.hpp y ejecutando Hyde; después, compara el comportamiento con y sin options.md. Rastrea la validación de la documentación para esta entrada; se considera terminado cuando un enum vacío ya no produce los errores de validación de documentación YAML o de archivo superfluo indicados.

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

Descripción

Expected Behaviour

To be able to leave an empty enum in the code, e.g.:

enum Options {
    // add your amazing option here
}

Why would I do this? Perhaps I have a bunch of code dependent on the enum (but not specific enum values) that I'm not ready to delete, because I expect to introduce different values into the enum in the future.

Actual Behaviour

Empty enums generate an error:

ERROR:root:FAILED: Hyde-validate for <path>/<to>/options.hpp
ERROR:root:        stdout: 
ERROR:root:        stderr: <path>/<to>/<docs>/options.md: extraneous file
Error: YAML documentation failed to validate.

If options.md is removed, a different error is generated:

ERROR:root:FAILED: Hyde-validate for <path>/<to>/options.hpp
ERROR:root:        stdout: 
ERROR:root:        stderr: Error: YAML documentation failed to validate.
Reproduce Scenario (including but not limited to)
Steps to Reproduce

Create an empty enum and run hyde

Platform and Version

Mac OS.

Sample Code that illustrates the problem
enum Options {
    // add your amazing option here
}
Logs taken while reproducing problem
Lenguaje dominante
C++
Estrellas
341
Forks
45
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

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 adobe/hyde

Todos los issues de adobe/hyde

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.