massive-com / massive-com/client-python
list_tickers() sorting behavior doesn't match documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1.5k
- Forks
- 362
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne bei RESTClient.list_tickers und der verknüpften Referenzdokumentation und reproduziere anschließend das search="THC"-Beispiel aus dem Issue. Prüfe, ob die zurückgegebene Reihenfolge von der API oder vom Client stammt, und betrachte die dokumentierte Relevanzreihenfolge erst dann als geklärt, wenn beobachtetes Verhalten und Dokumentation übereinstimmen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100