BlueBrain / BlueBrain/nexus-python-sdk

Harmonize nexus-python-sdk modules (e.g. docstrings)

Ouverte
#49 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 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`

Guide de contribution

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

Piste de recherche

Commencez par examiner les docstrings des modules et la documentation de nexus-python-sdk, en particulier projects.fetch ainsi que les entrées nexussdk.projects.deprecate et deprecate_2 mentionnées dans l’issue. Comparez la formulation, la ponctuation, les liens et les distinctions entre les méthodes dans les modules ; le travail est terminé lorsque toutes les incohérences répertoriées et la faute de frappe dans resources sont corrigées de manière cohérente.

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

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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