in 3.0.0 candidate the functions/constants descriptions are too small, lack LaTeX equations and have some unnecessary duplicated information

Đang mở
  • Có gì không ổn?
#175 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 2 ngày

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
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
Sôi nổi
Công nghệ
csharp
Lĩnh vực
documentation

Hướng nghiên cứu

The screenshots point to descriptions for functions and constants across many cases, but they do not identify the files or a specific entry point. Start by locating how those descriptions are defined and displayed in the 3.0.0 candidate. Done means removing duplicated syntax details and improving the text and equation presentation with LaTeX in the affected descriptions.

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

Mô tả

Image like for example here: "syntax" is basically a repeat of what we have in signature anyway and likely not needed, the text is very very small and likely too dry without much details and explanations and maybe examples or something and no LaTeX is used for presenting these defining equations nicely and readably

same here and I think this is for very many cases actually:

Image
Ngôn ngữ chính
C#
Star
249
Fork
53
Merge trung bình
1 ngày 20 giờ
Pull request đã merge (30 ngày)
157

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 PawelTroka/Computator.NET

Tất cả issue của PawelTroka/Computator.NET

Issue tương tự

Thêm issue về C#

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.