From 112b324e74390fc19b43563fd379ac132ded7b3c Mon Sep 17 00:00:00 2001 From: toyeshhm Date: Tue, 6 Oct 2026 09:23:42 -0500 Subject: [PATCH] Fix nonexistent file paths in Python client README and correct doc typos The Python client README pointed at client-py/src/iotdb/Session.py and client-py/src/SessionExample.py, and linked to client-py/SessionExample.py. None of those exist: the module is client-py/iotdb/Session.py and the example is client-py/session_example.py. Also corrects Futher -> Further in the same README, and mannually -> manually, offical -> official in docker/ReadMe.md. --- docker/ReadMe.md | 4 ++-- iotdb-client/client-py/README.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docker/ReadMe.md b/docker/ReadMe.md index 55a627e836e49..77ca0254aad3e 100644 --- a/docker/ReadMe.md +++ b/docker/ReadMe.md @@ -70,7 +70,7 @@ apache-iotdb-2.0.11-SNAPSHOT-all-bin.zip apache-iotdb-2.0.11-SNAPSHOT-ainode-bin.zip ``` -To avoid mannually copy these files, you can run our `do-docker-build.sh` with argument `-b`. +To avoid manually copy these files, you can run our `do-docker-build.sh` with argument `-b`. # How to run IoTDB server @@ -85,7 +85,7 @@ docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555 ```shell docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555 -p 9003:9003 -p 40010:40010 apache/iotdb: ``` -Since 1.0.0, see [offical documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html) +Since 1.0.0, see [official documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html) # How to register AINode to IoTDB cluster diff --git a/iotdb-client/client-py/README.md b/iotdb-client/client-py/README.md index 2441dfb866170..47ca3e908aa8e 100644 --- a/iotdb-client/client-py/README.md +++ b/iotdb-client/client-py/README.md @@ -47,7 +47,7 @@ You have to install thrift (>=0.14.1) before using the package. First, download the latest package: `pip3 install apache-iotdb` -You can get an example of using the package to read and write data at here: [Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/SessionExample.py) +You can get an example of using the package to read and write data at here: [Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/session_example.py) An example of aligned timeseries: [Aligned Timeseries Session Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/SessionAlignedTimeseriesExample.py) @@ -576,7 +576,7 @@ This folder is ignored from git and should **never be pushed to git!** ### Session Client & Example -We packed up the Thrift interface in `client-py/src/iotdb/Session.py` (similar with its Java counterpart), also provided an example file `client-py/src/SessionExample.py` of how to use the session module. please read it carefully. +We packed up the Thrift interface in `client-py/iotdb/Session.py` (similar with its Java counterpart), also provided an example file `client-py/session_example.py` of how to use the session module. please read it carefully. Or, another simple example: @@ -606,7 +606,7 @@ To run all defined tests just type `pytest .` in the root folder. -### Futher Tools +### Further Tools [black](https://pypi.org/project/black/) and [flake8](https://pypi.org/project/flake8/) are installed for autoformatting and linting. Both can be run by `black .` or `flake8 .` respectively.