Update documentation

Đang mở
#447 1 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
35/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 với tài liệu sử dụng cơ bản tại https://equinor.github.io/tagreader-python/docs/about/usage/basic-usage và so sánh các ví dụ trong đó với các hàm hiện tại của tagreader-python. Cập nhật các tên đã lỗi thời như verifySSL thành verify_ssl và kiểm tra các ví dụ xung quanh để tìm những điểm không khớp khác; hoàn thành khi tài liệu phản ánh API hiện tại.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Hi,

We see that there are many changes to the functions in tagreader-python. But the documentation doesn't reflect that. For example, the verifySSL is now verify_ssl.

Can you please have a look at this because it will save us time in the future?

Shrey

Ngôn ngữ chính
Python
Star
55
Fork
21
Merge trung bình
2 ngày 5 giờ
Pull request đã merge (30 ngày)
4

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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 equinor/tagreader-python

Tất cả issue của equinor/tagreader-python

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.