NativeScript / NativeScript/ios-device-lib

"upload" method is incorrectly described in the documentation

オープン
#52 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
C++
スター
16
フォーク
8
平均マージ
19時間 29分
マージ済み PR(30日)
2

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ドキュメント化されたアップロードインターフェースと、ソースコードが想定するリクエスト形式を比較します。ドキュメントの例を更新し、アップロードで source と destination のエントリを含む files 配列を使用するようにしてから、その例が実装と一致することを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。