Feedback for “Class”

Đang mở
#72 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
45/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ệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

Tìm phần tài liệu về “Class” và xem lại cách các field hiện đang được giải thích. Bổ sung hướng dẫn về các field pub, các hệ quả của chúng và lỗi NapiValue được mô tả trong issue; hoàn thành khi người đọc có thể hiểu tại sao một field pub vô tình lại gây ra lỗi này.

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

Mô tả

I'm trying to use napi-rs at the moment for a project and I'm generally very impressed and grateful for what you have created.

Yesterday I had the experience of getting quite confused about an error which said

the trait NapiValue is not implemented for MyValue

And I couldn't see anything about MyValue that would be causing the problem given how I was setting it up. It turned out that I had another struct with #[napi] which had a pub value: MyValue field and it was the pub that was triggering the error. It never should have been pub but I guess I typed it accidentally at some point. I realise it is hard to control the kind of errors that the compiler produces in this situation but I'm wondering if the docs could be extended to include a section about pub fields and their implications and the kind of error that I ran into.

I would be happy to try to provide some text or a PR if that would be useful.

Ngôn ngữ chính
MDX
Star
25
Fork
48
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
14

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 napi-rs/website

Tất cả issue của napi-rs/website

Issue tương tự

Thêm issue về Documentation

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.