BlueBrain / BlueBrain/nexus-python-sdk
Harmonize nexus-python-sdk modules (e.g. docstrings)
- 主要言語
- Python
- スター
- 6
- フォーク
- 10
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
This is feedback provided after a first usage of the nexus-python-sdk and its documentation to perform basic operations in a Nexus V1 deployment.
Regarding harmonisation, the following notes were taken:
* Standardise the wording of docstrings (e.g. in the docstring of returns: `**"Returns:** All the details of this organization, as a dictionary"` vs. `**"Returns:** The payload from the Nexus API as a dictionary. This contains the Nexus metadata of the organization"`
* Remove probabilistic wordings, such as `This is most likely the returned value of organisation.get(…)`
* Finish each sentence with a full stop
* Make difference between `nexussdk.projects.deprecate` and `nexussdk.projects.deprecate_2` explicit
* Include a link to the source code in the documentation
* Correct typo in `projects.fetch`; `Fetch a project and all its details. Note: This does not give the list of resources. To get that, use the resource package` should be `(...) resources package`
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
まず nexus-python-sdk のモジュール docstring とドキュメントを確認します。特に、projects.fetch と、issue で指定されている nexussdk.projects.deprecate および deprecate_2 のエントリを確認してください。モジュール間で文言、句読点、リンク、メソッドの区別を比較します。完了とは、列挙されているすべての不整合と resources の誤記が一貫して修正されている状態です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100