BlueBrain / BlueBrain/nexus-python-sdk
Take decision on whether / how the nexus-python-sdk checks Nexus API specific constraints
- Vorherrschende Sprache
- Python
- Sterne
- 6
- Forks
- 10
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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?
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginnen Sie mit der Überprüfung des Einstiegspunkts nexussdk.organizations.create und der Docstrings von nexus-python-sdk und vergleichen Sie anschließend die Fragen mit den Einschränkungen der Nexus V1 API. Als abgeschlossen gilt die Aufgabe, wenn das Projekt eine Entscheidung darüber festgehalten hat, ob die Einschränkungen von org_label validiert oder dokumentiert werden sollen und ob vocab und base definiert werden sollen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100