Request for exceptions usage documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- cpp
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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) ?
- Dominant language
- C++
- Stars
- 6.1k
- Forks
- 2.2k
- Avg merge
- 22h 2m
- Merged PRs (30d)
- 1
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jbeder/yaml-cpp
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
-
Difficulty 3/5 Half a day Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
Similar issues
-
devex good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
artifact:simulation-scenario domain:physics good first issue help wanted role:validation testing
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 3 days
-
[BUG] `mx.qqmm` docs: the Args section names `global_scale`, but the parameter is `global_scale_x`Possibly taken @Redempt1onzzZZ claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
ml-explore/mlx#4815 ·
Maintainers usually reply within 2 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day