kit-data-manager / kit-data-manager/ro-crate-java

Improve documentation around arrays as values of properties

Đang mở
#216 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation good first issue
Ngôn ngữ chính
Java
Star
5
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

This issue is opened as a response to https://github.com/kit-data-manager/ro-crate-java/issues/215.

- [ ] document the purpose of add* and set* methods in builders and their difference
- [ ] include array tests like encodingFormat if not already available and test/demonstrate if we can do this with the current API:
```json
{
"@id": "1st-tool.cwl",
"@type": "File",
"name": "First executable tool",
"description": "An example Common Workflow Language File",
"contentSize": "120",
"encodingFormat": ["text/plain", {"@id": "https://www.commonwl.org/v1.0/Workflow.html"}]
}
```
- [ ] There was no code given which generates this, but make sure this error message is only given in appropriate contexts:
```The property:
[ {
"@id" : "xsd:string"
} ]
does not comply with the flattened structure of the RO-Crate json document.
```

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 kiểm tra các phương thức add* và set* của builder cũng như các bài kiểm thử hiện có cho các thuộc tính có giá trị là mảng. Sử dụng ví dụ encodingFormat để kiểm tra xem API hiện tại có hỗ trợ các mảng hỗn hợp hay không, ghi lại sự khác biệt giữa các phương thức và xác minh khi nào lỗi cấu trúc phẳng là phù hợp.

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

Đánh giá

Công nghệ
java
Lĩnh vực
documentation, testing
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 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
38/100

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.