autoforce / autoforce/APIcasso
Adapt comments into RDoc convention
- Ngôn ngữ chính
- Ruby
- Star
- 31
- Fork
- 1
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
We already have an OK documentation present on the comments across the projects' files. This is fine, but RDoc pages are being generated with poorly formatted examples and some of the examples across the code are not being placed where it should.
This is very visible at our [Ability docs](https://www.rubydoc.info/gems/apicasso/0.4.11/Apicasso/Ability), which has fine examples, but they are very badly placed. Other examples are being poorly formatted, like the ones on the [CRUD Controller endpoints](https://www.rubydoc.info/gems/apicasso/0.4.11/Apicasso/CrudController).
This should be fixed for a better documentation.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Bắt đầu bằng cách xem xét các comment được render trong Ability docs và CRUD Controller endpoints được liên kết, sau đó tìm các comment nguồn tương ứng trong repository. So sánh các ví dụ được tạo với các quy ước của RDoc và xác minh rằng các ví dụ được định dạng và đặt đúng vị trí trong tài liệu kết quả.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- ruby
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100