BlueBrain / BlueBrain/nexus-python-sdk
Harmonize nexus-python-sdk modules (e.g. docstrings)
- Ngôn ngữ chính
- Python
- Star
- 6
- Fork
- 10
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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`
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Bắt đầu bằng việc xem xét các module docstring và tài liệu của nexus-python-sdk, đặc biệt là projects.fetch và các mục nexussdk.projects.deprecate và deprecate_2 được nêu trong issue. So sánh cách diễn đạt, dấu câu, liên kết và sự khác biệt giữa các phương thức trong các module; được xem là hoàn tất khi tất cả các điểm không nhất quán được liệt kê và lỗi chính tả trong resources đã được sửa một cách nhất quán.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100