Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Discuss member panels

Đang mở
  • Có gì không ổn?
#50 10 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
20/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
fsharp
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét quá trình tạo member-panel của FSharp.Formatting trong bối cảnh các chú thích XML của FSharp.Core được tham chiếu ở đây. So sánh các mô tả kiểu và tham số được đề xuất ở dạng hợp nhất, các trang theo từng member, bố cục dọc và các danh sách chỉ có phần tóm tắt với các ví dụ PyTorch; được xem là hoàn tất khi đã đi đến và ghi lại một quyết định thiết kế thống nhất.

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

Mô tả

fsdocs

Hi all,

I'd like to discuss the member panels (and the documentation for members more generally) coming out of FSharp.Formatting. I think it's good to do this in the context of FSharp.Core where we have relatively populated XML comments, though it's a more general FSharp.Formatting issue

For FSharp.Core a typical member panel looks like this:

image

Now, the things I'd like some help with are

  1. Should the parameter types and the parameter descriptions be merged together? The F#F codebase is now getting to a point where it's cleaned up enough (and I understand it well enough) to allow this to happen. But what visuals do we want? Are there any really nice docs elsewhere integrating type information and documentation you can point me to?

  2. Do we actually need to move to generating one page per member, especially when example usage starts being added? A library like PyTorch doesn't do this but of course MSDN does.

  3. The left-right display of the member usage feels like wasted space. Perhaps each member should be stacked.

Here's an example of PyTorch (not necesarily great documentation though nor exemplar for FSHarp.Core)

Member list:

image

Member page:

image

The things I notice are:

  • one page for each member

  • vertical stacking

  • types go in italics , parenthesized

  • only summary text on member list page

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
37
Fork
20
Merge trung bình
5 phút
Pull request đã merge (30 ngày)
2

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

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. 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 fsharp/fsharp-core-docs

Tất cả issue của fsharp/fsharp-core-docs

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.