NativeScript / NativeScript/ios-device-lib

"upload" method is incorrectly described in the documentation

Đang mở
#52 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Ngôn ngữ chính
C++
Star
16
Fork
8
Merge trung bình
19 giờ 29 phút
Pull request đã merge (30 ngày)
2

Mô tả

The documentation for "upload" method states next required interface:

{
  "methods": [
    {
      "id": "5",
      "name": "upload",
      "args": [
        {
          "appId": "com.sample.MyApp",
          "deviceId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "source": "D:\\Project\\app.js",
          "destination": "Library\\Application Support\\LiveSync\\app\\app.js"
        }
      ]
    }
  ]
}

but the source code, actually, expects next one:

{
  "methods": [
    {
      "id": "5",
      "name": "upload",
      "args": [
        {
          "appId": "com.sample.MyApp",
          "deviceId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "files": [
            {
              "source": "D:\\Project\\app.js",
              "destination": "Library\\Application Support\\LiveSync\\app\\app.js"
            },
            ...
          ]
        }
      ]
    }
  ]
}

the discrepancy in the documentation made me spend time to figure out why the upload method does not work

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

So sánh giao diện upload được ghi trong tài liệu với cấu trúc request mà mã nguồn mong đợi. Cập nhật ví dụ trong tài liệu để upload sử dụng một mảng files chứa các mục source và destination, sau đó xác minh rằng ví dụ khớp với phần triển khai.

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

Đánh giá

Công nghệ
cpp
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
55/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.