Request for exceptions usage documentation

未关闭
#1,122 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
cpp
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

documentation help wanted

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) ?

主要语言
C++
星标
6.1k
派生
2.2k
平均合并
22 小时 2 分钟
30 天内合并 PR
1

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

jbeder/yaml-cpp 的其他 Issue

查看 jbeder/yaml-cpp 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。