massive-com / massive-com/client-python
list_tickers() sorting behavior doesn't match documentation
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 1.5k
- Forks
- 362
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza en RESTClient.list_tickers y en la documentación de referencia enlazada; después, reproduce el ejemplo search="THC" del issue. Comprueba si el orden devuelto proviene de la API o del cliente, y considera resuelto el orden de relevancia documentado solo cuando el comportamiento observado y la documentación coincidan.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- api
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100