Skip to content

Fix nonexistent file paths in Python client README and correct doc typos - #18797

Merged
HTHou merged 1 commit into
apache:masterfrom
toyeshhm:fix-doc-typos
Oct 8, 2026
Merged

HTHou merged 1 commit into
apache:masterfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

@toyeshhm toyeshhm commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes file paths in the Python client README that point at files which do not exist, plus a few typos.

Broken paths in the Python client README

iotdb-client/client-py/README.md says the Thrift interface is wrapped in client-py/src/iotdb/Session.py and that an example lives at client-py/src/SessionExample.py. There is no src/ directory under iotdb-client/client-py; the module is client-py/iotdb/Session.py and the example is client-py/session_example.py. The "Example" link near the top of the same README pointed at client-py/SessionExample.py on master, which is a 404, and now points at session_example.py.

Typos

  • iotdb-client/client-py/README.md: "Futher Tools" -> "Further Tools"
  • docker/ReadMe.md: "mannually" -> "manually", "offical" -> "official"

This PR has:

  • been self-reviewed.

Documentation only; no code changes.

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.
Copilot AI balanced review requested due to automatic review settings October 7, 2026 20:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@HTHou
HTHou merged commit a1c0e90 into apache:master Oct 8, 2026
42 of 43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants