AnswerDotAI / AnswerDotAI/nbdev

nbdev_readme fails with mysterious error if docstring contains "\"

Đang mở
#1,455 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
bug
Ngôn ngữ chính
Jupyter Notebook
Star
5.3k
Fork
513
Merge trung bình
2 ngày 30 phút
Pull request đã merge (30 ngày)
8

Mô tả

`nbdev_readme` fails if I have a backslash in the docstring of any exported function, e.g.

```
#| export
def f():
"""
Example doctring $x \mapsto y$
"""
return None
```
The resulting error message is very long and does not indicate the problem (although it does point to the offending function).

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách tái hiện lỗi với nbdev_readme bằng một hàm được export có docstring chứa biểu thức dấu gạch chéo ngược được nêu. Truy vết lỗi được tạo ra về hàm gây ra lỗi và xác định liệu kết quả mong đợi là xử lý thành công hay một thông báo ngắn gọn chỉ ra vấn đề với dấu gạch chéo ngược.

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

Đánh giá

Công nghệ
jupyter-notebook, python
Lĩnh vực
documentation, tooling
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
42/100

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.