Suggestion for revising documentation on writing custom parsers

Đang mở
#208 0 bình luận 1 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
Khá 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

Bắt đầu trong doc/tutorial.qbk, khoảng dòng 3792, và đọc phần thảo luận về các parser tùy chỉnh. Sửa lại cách diễn đạt để trung lập hơn và thêm hướng dẫn hoặc một ví dụ đề cập đến các literal phức tạp như 5 'D 3 của SystemVerilog. Công việc được xem là hoàn tất khi phần này giải thích khi nào parser tùy chỉnh là phù hợp và cung cấp hướng dẫn thực tế cho người dùng.

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

Mô tả

https://github.com/boostorg/parser/blob/f468d529fe440313d9d67d092f360b1a64a6f702/doc/tutorial.qbk#L3792

Thank you for your work on Boost Parser. It's an impressive library, and I've found it quite powerful.

While I appreciate the humor in the writing, I found the tone to be slightly dismissive of scenarios where writing custom parsers might genuinely be the most effective solution. For instance, I am working on parsing SystemVerilog code, which includes number literals with unique syntax, such as 5 'D 3. Parsing such constructs character by character using char_ primitives seems neither convenient nor effective, and it would make a strong case for writing a custom parser akin to uint_.

I believe this use case illustrates that there are situations where users might reasonably need more guidance on creating low-level parsers. If this section of the documentation could include:

  1. A more neutral tone when addressing the use of custom parsers.
  2. An example of how to effectively handle complex cases (like SystemVerilog number literals) using the library's primitives or via a custom parser.

This approach would make the documentation more inclusive and better serve a wider range of users.

Thank you again for your efforts, and I hope my feedback helps in further refining the excellent resources you provide.

Ngôn ngữ chính
C++
Star
182
Fork
28
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 boostorg/parser

Tất cả issue của boostorg/parser

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.