Request for exceptions usage documentation
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
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- cpp
- Área
- documentation
Línea de trabajo
Start with src/exceptions.cpp, which the issue identifies as a possible list of exceptions, and compare it with the exception handling and node lookup paths that determine what users can catch. Document each exception's meaning and when it is thrown, including the KeyNotFound example. Done means users can find a reliable explanation of the exceptions exposed by yaml-cpp.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Thank you for the work on this great project. I wanted to ask you for documentation ( I could not find on my own ) for exceptions' specific usage.
For instance it is not clear which exceptions are propagated up to the user's logic and which are consumed internally. I found this file and it seems theses are the exceptions the user can expect to catch from yaml-cpp. However, I am not completely sure.
There are certain types of exceptions I could not manually force yaml-cpp to throw.
For instance the YAML::KeyNotFound exception is not thrown when you do this:
YAML::Node node_representing_yaml_config = YAML::LoadFile("example.yaml");
node_representing_yaml_config["notpresentkey"];
TL;DR
What are the exceptions the user can expect yaml-cpp to throw and when each of them is thrown (logically/semantically) ?
- Lenguaje dominante
- C++
- Estrellas
- 6.1k
- Forks
- 2.2k
- Merge medio
- 22 h 2 min
- PR fusionados (30 d)
- 1
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de jbeder/yaml-cpp
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
-
Dificultad 3/5 Medio día Aptitud para principiantes 55/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
Todos los issues de jbeder/yaml-cpp
Issues similares
-
libc++ test-suite
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
llvm/llvm-project#239851 ·
Los mantenedores suelen responder en 1 día
-
Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
scipy/xsf#454 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug :bug:
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
comp-documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 84/100
ClickHouse/ClickHouse#129829 ·
Los mantenedores suelen responder en 1 día
-
feature request Python
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 2 días