BlueBrain / BlueBrain/nexus-python-sdk

Take decision on whether / how the nexus-python-sdk checks Nexus API specific constraints

オープン
#50 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
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 propagating specifics from the Nexus API, the following questions were noted:

* Should constraints given by the Nexus API be checked / explicitely stated in the nexus-python-sdk, e.g. should the parameter `org_label` in `nexussdk.organizations.create` be checked to not contain upper case letters or spaces?
* Should terms like `vocab` and `base` be further described in the docstrings of the nexus-python-sdk?

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

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず nexussdk.organizations.create のエントリポイントと nexus-python-sdk の docstring を確認し、その後、質問を Nexus V1 API の制約と照合します。完了とは、org_label の制限を検証するか文書化するか、および vocab と base を定義するかについて、プロジェクトが判断を記録している状態を意味します。

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

評価

技術スタック
python
領域
api
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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