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

Đang mở
#49 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

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.

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
Ngôn ngữ chính
Python
Star
6
Fork
10
Không có pull request nào được merge trong 30 ngày

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của BlueBrain/nexus-python-sdk

Tất cả issue của BlueBrain/nexus-python-sdk

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.