Harmonize nexus-python-sdk modules (e.g. docstrings)
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
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.
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.deprecateandnexussdk.projects.deprecate_2explicit - 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 packageshould be(...) resources package
- Dominant language
- Python
- Stars
- 6
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from BlueBrain/nexus-python-sdk
-
Fetch File metadata Open
Difficulty 3/5 1-2 days Newbie friendliness 45/100
BlueBrain/nexus-python-sdk#100 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
BlueBrain/nexus-python-sdk#85 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
BlueBrain/nexus-python-sdk#55 · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
All issues in BlueBrain/nexus-python-sdk
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100