Crate's docs.rs page irritatingly empty

Đang mở
  • Có gì không ổn?
#2,019 3 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
rust
Lĩnh vực
documentation, web-dev

Hướng nghiên cứu

Bắt đầu bằng cách mở các trang docs.rs được liên kết và sử dụng menu thả xuống Platform để tái hiện chế độ xem mặc định trống và các biến thể không trống hiện có. Đọc các yêu cầu được đề xuất trong issue về lựa chọn nền tảng dựa trên trình duyệt và thông báo fallback; được xem là hoàn tất khi một nền tảng không trống phù hợp được chọn nếu có thể, kèm hướng dẫn rõ ràng khi phải chọn một biến thể khác.

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

Mô tả

A-builds E-medium

Only after much irritation, I understood that using #![cfg(target_os = "windows")] is responsible for my crates https://docs.rs/win-beep/latest/win_beep/ and https://docs.rs/vcvars/latest/vcvars/ showing empty documentation. How must it be for a potential user of the crates?

I read that using #![cfg(target_os = "windows")] is better than causing compiler errors in a crate dependency (the crate being the dependency of others).

I now know that I can show the documentation by choosing an entry from the "Platform" drop-down menu (the entries are quite cryptic though, easily scaring you off). But I think docs.rs should, e.g., automatically choose a non empty "Platform" entry to be displayed.

Maybe it would be best to choose a platform that corresponds to what can be retrieved from the running browser (favoring 64 bits, of course, if this info can't be retrieved). And if that would result in an empty crate, show a message, if true, that there are other non-empty crate variants behind the "Platform" drop-down menu.

Ngôn ngữ chính
Rust
Star
1.2k
Fork
235
Merge trung bình
11 giờ 56 phút
Pull request đã merge (30 ngày)
78

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

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 rust-lang/docs.rs

Tất cả issue của rust-lang/docs.rs

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.