Docs refactor: use `#[cfg(doc)]`

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#187 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 7 ngày

@Sweesz đang làm issue này rồi.

Từ ngày 31/10/2026.

  • #2 của @Sweesz — đang mở

Đá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
72/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách tìm trong thư viện các import chỉ dành cho tài liệu được đánh dấu bằng #[allow(unused_imports)], rồi so sánh chúng với các ví dụ trong issue. Thay các annotation phù hợp bằng #[cfg(doc)]; công việc hoàn tất khi các import đó chỉ được bật trong các bản build tài liệu.

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

Mô tả

documentation good first issue help wanted refactor

A common problem is that the sample code in crate docs ofter needs access to more primitives than the actual source code does, RNG or KeyMaterial, etc. We have blocks like this sprinkled across the library:

// imports just for docs
#[allow(unused_imports)]
use crate::mlkem::MLKEMTrait;
#[allow(unused_imports)]
use crate::polynomial::Polynomial;

A better pattern would be:

// imports just for docs
#[cfg(doc)] use crate::mlkem::MLKEMTrait;
#[cfg(doc)] use crate::polynomial::Polynomial;

This should be a simple mechanical refactor.

Ngôn ngữ chính
Rust
Star
25
Fork
18
Merge trung bình
7 ngày 4 giờ
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 bcgit/bc-rust

Tất cả issue của bcgit/bc-rust

Issue tương tự

Thêm issue về Rust

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.