massive-com / massive-com/client-python
list_tickers() sorting behavior doesn't match documentation
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 1.5k
- 派生
- 362
- PR 合并指标
- 30 天内没有已合并 PR
描述
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.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 RESTClient.list_tickers 和链接的 Reference 文档开始,然后重现 issue 中的 search="THC" 示例。检查返回的排序来自 API 还是客户端,并且只有在观察到的行为与文档一致时,才能认为文档所述的相关性排序已经得到确认。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- api
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100