BlueBrain / BlueBrain/nexus-python-sdk

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

Ouverte
#50 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
6
Forks
10
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par examiner le point d’entrée nexussdk.organizations.create et les docstrings de nexus-python-sdk, puis comparez les questions aux contraintes de la Nexus V1 API. C’est terminé lorsque le projet a consigné une décision indiquant s’il faut valider ou documenter les restrictions de org_label et s’il faut définir vocab et base.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.