Doc improvment

未关闭

#646 创建于 2024年3月21日 3 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 4/5
预计耗时: 3-5 天
新手友好度: 35/100

Issue 类型: 文档
描述清晰度: 需要澄清
活跃度: 停滞
技术栈: python
领域: documentation

调研方向

首先比较 issue 中链接的 v1 和 v2 文档页面，然后检查此客户端仓库中的文档入口以及所引用的 v1 库。Done 应包括从旧文档到 v2 文档的清晰路径，以及区分受支持的 Python、客户端库和 InfluxDB 版本的指南。

由索引模型根据 Issue 内容生成。

描述

question

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

主要语言: Python
星标: 792
派生: 186
平均合并: 3 小时 2 分钟
30 天内合并 PR: 1

贡献指南

这个仓库没有索引到贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

influxdata/influxdb-client-python 的其他 Issue

Pandas outputs warning when calling dataframe.append in flux_csv_parser._prepare_data_frame 未关闭

bug

难度 2/5 1-3 小时新手友好度 68/100

influxdata/influxdb-client-python#613 · 7 条评论 · 2023年9月19日创建
ApiClient.__del__ triggers shutdown-time exception in influxdb-client 1.50.0 未关闭

bug

难度 3/5 1-2 天新手友好度 65/100

influxdata/influxdb-client-python#719 · 2026年9月24日创建
Public symbols not properly exported with `py.typed` present — triggers Pylance/Pyright errors 未关闭

难度 3/5 1-2 天新手友好度 45/100

influxdata/influxdb-client-python#694 · 6 个 reaction · 2025年5月13日创建
When writing a batch to an implicit bucket upon schema conflict, I receive a 400. The logs seems to be f-printed. 未关闭

bug

难度 3/5 1-2 天新手友好度 30/100

influxdata/influxdb-client-python#693 · 2 条评论 · 1 个 reaction · 2025年4月25日创建
Socks proxy support 未关闭

难度 4/5 3-5 天新手友好度 35/100

influxdata/influxdb-client-python#692 · 2025年4月19日创建

查看 influxdata/influxdb-client-python 的全部 Issue

相似的 Issue

validate-structure inspecte challenge/work/.terraform et rend faux les labs qui ont un provider en cache 未关闭

bug

难度 2/5 1-3 小时新手友好度 75/100

stephrobert/dsoxlab#238 · 2026年9月24日创建
Uniform probability densities use the upper bound as an interval width 未关闭

难度 2/5 1-3 小时新手友好度 75/100

nasa/fmdtools#40 · 2026年9月24日创建
_common_folder() treats a single file as the common folder; single-file archives can't be installed (4.2.8) / crash (master) 未关闭

难度 2/5 1-3 小时新手友好度 75/100

sublimehq/package_control#1780 · 2026年9月24日创建
Set 'Sample' input in 'autorun.py' to utilize 'Sample' Tab in eLog 未关闭

难度 2/5 1-3 小时新手友好度 65/100

pcdshub/mfx#309 · 2 条评论 · 2026年9月24日创建
niri config file addition does not respect existing optional include 未关闭

难度 2/5 1-3 小时新手友好度 70/100

nwg-piotr/nwg-displays#145 · 2026年9月24日创建

更多 Python Issue