BlueBrain / BlueBrain/nexus-python-sdk
Harmonize nexus-python-sdk modules (e.g. docstrings)
- Lenguaje dominante
- Python
- Estrellas
- 6
- Forks
- 10
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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`
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100