BlueBrain / BlueBrain/nexus-python-sdk
Harmonize nexus-python-sdk modules (e.g. docstrings)
- 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 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`
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne mit der Überprüfung der Modul-Docstrings und der Dokumentation von nexus-python-sdk, insbesondere von projects.fetch sowie den in der Issue genannten Einträgen nexussdk.projects.deprecate und deprecate_2. Vergleiche Formulierungen, Zeichensetzung, Links und Methodenunterscheidungen zwischen den Modulen; als erledigt gilt die Aufgabe, wenn alle aufgeführten Inkonsistenzen und der Tippfehler bei resources konsistent korrigiert sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100