list_tickers() sorting behavior doesn't match documentation

Đang mở
#899 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
35/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu từ RESTClient.list_tickers và tài liệu Reference được liên kết, sau đó tái hiện ví dụ search="THC" trong issue. Kiểm tra xem thứ tự được trả về đến từ API hay client, và chỉ xem thứ tự theo mức độ liên quan được tài liệu hóa là đã được xác định khi hành vi quan sát được khớp với tài liệu.

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

Mô tả

bug

Describe the bug

The documentation of the Python lib. states that if the "search" argument is given, list_tickers' results would be sorted by relevance:

https://polygon-api-client.readthedocs.io/en/latest/Reference.html#polygon.RESTClient.list_tickers

but it doesn't seem to be the case.

when using the example i included below, results are sorted by ticker.

To Reproduce
`from polygon import RESTClient

client = RESTClient("api-key")

tickers = []

for t in client.list_tickers(market="stocks", search="THC", limit=10,):
tickers.append(t)

print(tickers)
`

Expected behavior
I would have liked the results to be sorted by relevance to the search term.

Ngôn ngữ chính
Python
Star
1.5k
Fork
362
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 massive-com/client-python

Tất cả issue của massive-com/client-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.