Request for exceptions usage documentation

Đang mở
  • Có gì không ổn?
#1,122 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
cpp
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
C++
Star
6.1k
Fork
2.2k
Merge trung bình
22 giờ 2 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của jbeder/yaml-cpp

Tất cả issue của jbeder/yaml-cpp

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.