BlueBrain / BlueBrain/nexus-python-sdk

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

Aperta
#49 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
6
Fork
10
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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`

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Start by reviewing the nexus-python-sdk module docstrings and documentation, especially projects.fetch and the nexussdk.projects.deprecate and deprecate_2 entries named in the issue. Compare wording, punctuation, links, and method distinctions across the modules; done means all listed inconsistencies and the resources typo are corrected consistently.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.