Doc improvment
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza comparando las páginas de documentación de v1 y v2 enlazadas en el issue; después, inspecciona los puntos de entrada de la documentación en este repositorio del cliente y la biblioteca v1 referenciada. Done debe incluir una ruta clara desde la documentación antigua hasta la documentación de v2 y una guía que distinga entre las versiones compatibles de Python, la biblioteca del cliente e InfluxDB.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Specifications
Minor item... As I'm navigating various online docs, I found these two:
old v1 client library: https://influxdb-python.readthedocs.io/en/latest/include-readme.html
new v2 client library: https://influxdb-client.readthedocs.io/en/stable/
It would have been convenient (for me) for the old doc to link to the newer doc, but that github repository is archived:
This repository has been archived by the owner on Jul 18, 2023. It is now read-only.
This is in the influxdata github repository so I will just leave this here as a suggested fix if that's OK.
Of course, I could have navigated github itself and found v2 docs that way...
More generally - are there no conventions (in Python) for indicating which versions we are working with? I'm currently learning python 3.12, influx client 2, influx 2.x and regularly stumbling into older examples and documentation. I have an extensive IT background so ought to know how to locate docs and resources, but it's like we're purposely making life hard for our (future) selves.
Code sample to reproduce problem
N/A
Expected behavior
N/A
Actual behavior
N/A
Additional info
This has been added by Zoe - The devrel. To come back and address in here, the v1 library, and the docs
- Lenguaje dominante
- Python
- Estrellas
- 792
- Forks
- 186
- Merge medio
- 3 h 2 min
- PR fusionados (30 d)
- 1
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.
Más de influxdata/influxdb-client-python
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
influxdata/influxdb-client-python#613 · 7 comentarios ·
-
Public symbols not properly exported with `py.typed` present — triggers Pylance/Pyright errors Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
influxdata/influxdb-client-python#694 · 6 reacciones ·
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 30/100
influxdata/influxdb-client-python#693 · 2 comentarios · 1 reacción ·
-
Socks proxy support Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
bug
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
Todos los issues de influxdata/influxdb-client-python
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
anthropics/skills#1811 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
speaches-ai/speaches#678 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
datalayer/mcp-compose#42 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
conda-forge/spacy-feedstock#177 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
UKGovernmentBEIS/inspect_evals#2523 ·