BlueBrain / BlueBrain/nexus-python-sdk

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

Open
#49 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
6
Forks
10
PR merge metrics
No merged PRs in 30d

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`

Contributor guide

No contributing guide indexed for this repository

Research direction

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.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.