Skip to content

Commit a1c0e90

Browse files
authored
Fix nonexistent file paths in Python client README and correct doc typos (#18797)
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.
1 parent 28c1938 commit a1c0e90

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

‎docker/ReadMe.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ apache-iotdb-2.0.11-SNAPSHOT-all-bin.zip
7070
apache-iotdb-2.0.11-SNAPSHOT-ainode-bin.zip
7171
```
7272

73-
To avoid mannually copy these files, you can run our `do-docker-build.sh` with argument `-b`.
73+
To avoid manually copy these files, you can run our `do-docker-build.sh` with argument `-b`.
7474

7575
# How to run IoTDB server
7676

@@ -85,7 +85,7 @@ docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555
8585
```shell
8686
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:<version>
8787
```
88-
Since 1.0.0, see [offical documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html)
88+
Since 1.0.0, see [official documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html)
8989

9090
# How to register AINode to IoTDB cluster
9191

‎iotdb-client/client-py/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ You have to install thrift (>=0.14.1) before using the package.
4747

4848
First, download the latest package: `pip3 install apache-iotdb`
4949

50-
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)
50+
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)
5151

5252
An example of aligned timeseries: [Aligned Timeseries Session Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/SessionAlignedTimeseriesExample.py)
5353

@@ -576,7 +576,7 @@ This folder is ignored from git and should **never be pushed to git!**
576576

577577
### Session Client & Example
578578

579-
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.
579+
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.
580580

581581

582582
Or, another simple example:
@@ -606,7 +606,7 @@ To run all defined tests just type `pytest .` in the root folder.
606606

607607

608608

609-
### Futher Tools
609+
### Further Tools
610610

611611
[black](https://pypi.org/project/black/) and [flake8](https://pypi.org/project/flake8/) are installed for autoformatting and linting.
612612
Both can be run by `black .` or `flake8 .` respectively.

0 commit comments

Comments
 (0)