Skip to content

fix: code type error in python API docs #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −20
Open

fix: code type error in python API docs #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/UserGuide/Master/Table/API/Programming-Python-Native-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ IoTDB provides a Python native client driver and a session pool management mecha

To use the IoTDB Python API, install the required package using pip:

```Java
```sh
pip3 install apache-iotdb==2.0.1b0
```

Expand Down Expand Up @@ -175,7 +175,7 @@ class TableSessionConfig(object):

#### Sample Code

```Java
```python
def get_session(self) -> TableSession:
"""
Retrieve a new TableSession instance.
Expand Down Expand Up @@ -223,7 +223,7 @@ def close(self):

#### Sample Code

```Java
```python
class TableSessionPoolConfig(object):
"""
Configuration class for a TableSessionPool.
Expand Down Expand Up @@ -285,7 +285,7 @@ class TableSessionPoolConfig(object):

Here is an excerpt of the sample code:

```Java
```python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
Expand Down
8 changes: 4 additions & 4 deletions src/UserGuide/latest-Table/API/Programming-Python-Native-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ IoTDB provides a Python native client driver and a session pool management mecha

To use the IoTDB Python API, install the required package using pip:

```Java
```sh
pip3 install apache-iotdb==2.0.1b0
```

Expand Down Expand Up @@ -175,7 +175,7 @@ class TableSessionConfig(object):

#### Sample Code

```Java
```python
def get_session(self) -> TableSession:
"""
Retrieve a new TableSession instance.
Expand Down Expand Up @@ -223,7 +223,7 @@ def close(self):

#### Sample Code

```Java
```python
class TableSessionPoolConfig(object):
"""
Configuration class for a TableSessionPool.
Expand Down Expand Up @@ -285,7 +285,7 @@ class TableSessionPoolConfig(object):

Here is an excerpt of the sample code:

```Java
```python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
Expand Down
12 changes: 6 additions & 6 deletions src/zh/UserGuide/Master/Table/API/Programming-Python-Native-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

安装依赖包:

```Java
```sh
pip3 install apache-iotdb==2.0.1b0
```

Expand All @@ -51,7 +51,7 @@ TableSession是IoTDB的一个核心类，用于与IoTDB数据库进行交互。
**TableSession:**


```Java
```python
class TableSession(object):
def insert(self, tablet: Union[Tablet, NumpyTablet]):
"""
Expand Down Expand Up @@ -126,7 +126,7 @@ TableSessionConfig是一个配置类，用于设置和创建TableSession 实例

#### 2.2.3 接口展示

```Java
```python
class TableSessionConfig(object):
"""
Configuration class for a TableSession.
Expand Down Expand Up @@ -187,7 +187,7 @@ TableSessionPool 是一个会话池管理类，用于管理 TableSession 实例

**TableSessionPool:**

```Java
```python
def get_session(self) -> TableSession:
"""
Retrieve a new TableSession instance.
Expand Down Expand Up @@ -238,7 +238,7 @@ TableSessionPoolConfig是一个配置类，用于设置和创建 TableSessionPoo
#### 3.2.3 接口展示


```Java
```python
class TableSessionPoolConfig(object):
"""
Configuration class for a TableSessionPool.
Expand Down Expand Up @@ -293,7 +293,7 @@ Session示例代码:[Session Example](https://github.com/apache/iotdb/blob/rc/2.

SessionPool示例代码:[SessionPool Example](https://github.com/apache/iotdb/blob/rc/2.0.1/iotdb-client/client-py/table_model_session_pool_example.py)

```Java
```python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
Expand Down
12 changes: 6 additions & 6 deletions src/zh/UserGuide/latest-Table/API/Programming-Python-Native-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

安装依赖包:

```Java
```sh
pip3 install apache-iotdb==2.0.1b0
```

Expand All @@ -51,7 +51,7 @@ TableSession是IoTDB的一个核心类，用于与IoTDB数据库进行交互。
**TableSession:**


```Java
```python
class TableSession(object):
def insert(self, tablet: Union[Tablet, NumpyTablet]):
"""
Expand Down Expand Up @@ -126,7 +126,7 @@ TableSessionConfig是一个配置类，用于设置和创建TableSession 实例

#### 2.2.3 接口展示

```Java
```python
class TableSessionConfig(object):
"""
Configuration class for a TableSession.
Expand Down Expand Up @@ -187,7 +187,7 @@ TableSessionPool 是一个会话池管理类，用于管理 TableSession 实例

**TableSessionPool:**

```Java
```python
def get_session(self) -> TableSession:
"""
Retrieve a new TableSession instance.
Expand Down Expand Up @@ -238,7 +238,7 @@ TableSessionPoolConfig是一个配置类，用于设置和创建 TableSessionPoo
#### 3.2.3 接口展示


```Java
```python
class TableSessionPoolConfig(object):
"""
Configuration class for a TableSessionPool.
Expand Down Expand Up @@ -293,7 +293,7 @@ Session示例代码:[Session Example](https://github.com/apache/iotdb/blob/rc/2.

SessionPool示例代码:[SessionPool Example](https://github.com/apache/iotdb/blob/rc/2.0.1/iotdb-client/client-py/table_model_session_pool_example.py)

```Java
```python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
Expand Down