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

Documentation Enhancement

Đang mở
  • Có gì không ổn?
#399 1 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
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
clojure
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách so sánh hàm help trong src/compojure/api/help.clj với phần triển khai mẫu trong src/compojure/api/core.clj, sau đó xem lại tài liệu hiện có trong src/compojure/api/meta.clj. Issue này cần maintainer quyết định nên tạo Markdown thông qua help hay cập nhật trực tiếp các docstrings; được xem là hoàn tất khi một cách tiếp cận đã thống nhất được triển khai và tài liệu được cập nhật.

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

Mô tả

docs help wanted

I've been thinking about expanding some of the docstrings, but I'm not sure how is best to go about it.

One option is to just copy the output of the help function but change it to use markdown instead of plain text, I've made a quick sample implementation here. I realise that this copy pasting of documentation makes it harder to keep updated so this option isn't perfect by any means. I also don't think that the documentation in meta has been updated in 2 years so it might not be perfectly up to date but presumably this can be easily fixed (I know that it definitely has one or two spelling mistakes to be fixed).

Another way I could achieve the same effect could be to change the functions in the help namespace to accept an output-type parameter, or something similar, to change the output to generate markdown instead of plain text. This would mean making a code change though and although I don't see the help function used anywhere else in the code, I don't know who else might be using it.

My question here is what do you think would be the best way to make this change? The hope is to eventually submit this as a pull request.

Ngôn ngữ chính
Clojure
Star
1.1k
Fork
145
Không có pull request nào được merge trong 30 ngày

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 metosin/compojure-api

Tất cả issue của metosin/compojure-api

Issue tương tự

Thêm issue về Clojure

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.