Implement type hints on top of docstring `rtype`
まだ誰も着手していません。
評価
調査の方向性
まず、issue で名前が挙げられているクライアントファクトリメソッド（get_git_client や get_build_client など）を見つけ、それらの docstring の rtype 宣言が返されるクライアントにどのように対応しているかを確認します。アノテーションが必要なファクトリの範囲を特定し、結果として得られる戻り値の型によって analyzer のオートコンプリートが復元されることを検証します。この issue では、具体的なファイルやテストは指定されていません。
索引モデルが issue の本文から書いたものです。
説明
Hi,
The code is quite well documented, and uses docstring heavily. However, the "Python way" is to use type hints which are powerful and enable a good code completion.
For exaample, the client factory (get_git_client, get_build_client, ...) does not have type hints. Due to how it is written, python analyzers can not infer the returned types and this breaks autocompletion.
Could you please generate them them?
For example something like this:
def get_git_client(self) -> GitClient:
"""get_git_client.
Gets the 7.0 version of the GitClient
:rtype: :class:`<GitClient> <azure.devops.v7_0.git.git_client.GitClient>`
"""
return self._connection.get_client('azure.devops.v7_0.git.git_client.GitClient')
Thanks !
- 主要言語
- Python
- スター
- 684
- フォーク
- 218
- 平均マージ
- 8日 10時間
- マージ済み PR（30日）
- 1
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/azure-devops-python-api のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 55/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
microsoft/azure-devops-python-api の issue をすべて見る
似ている issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
canonical/paas-charm#368 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
tech debt
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
StevenBlack/hosts#3256 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
qualcomm/qai-appbuilder#275 ·