Skip to content

docs: update python docs#34686

Open
qevolg wants to merge 6 commits intomainfrom
docs/main/6735486234
Open

docs: update python docs#34686
qevolg wants to merge 6 commits intomainfrom
docs/main/6735486234

Conversation

@qevolg
Copy link
Contributor

@qevolg qevolg commented Mar 5, 2026

Description

docs: update python docs

Issue(s)

Checklist

Please check the items in the checklist if applicable.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

Copilot AI review requested due to automatic review settings March 5, 2026 07:36
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the Python connector documentation to reflect recent enhancements in authentication mechanisms. It introduces new versions of both the Python and WebSocket connectors that support token-based authentication for data subscriptions and clarifies the usage and priority of different authentication tokens for database connections.

Highlights

  • Documentation Updates for Python and WebSocket Connectors: New entries were added for Python Connector version 2.8.9 and WebSocket Connector version 0.6.6, both highlighting support for token authentication in data subscription.
  • Authentication Token Clarification: The documentation for td.connect.token was updated to clarify its role as a 'Cloud service authentication token', and a new parameter td.connect.bearer_token was introduced for database authentication with higher priority.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/en/14-reference/05-connector/30-python.md
    • Added Python Connector version 2.8.9, noting data subscription token authentication.
    • Added WebSocket Connector version 0.6.6, noting data subscription token authentication.
    • Updated description for td.connect.token to 'Cloud service authentication token' and introduced td.connect.bearer_token as a higher-priority database authentication token.
    • Revised td.connect.token description in another section to 'Database authentication token, with higher authentication priority than username and password.'
  • docs/zh/14-reference/05-connector/30-python.mdx
    • Added Python Connector version 2.8.9, noting data subscription token authentication.
    • Added WebSocket Connector version 0.6.6, noting data subscription token authentication.
    • Updated description for td.connect.token to '云服务认证 token' (Cloud service authentication token) and introduced td.connect.bearer_token as a higher-priority database authentication token.
    • Revised td.connect.token description in another section to '数据库认证 token,认证优先级高于用户名密码' (Database authentication token, with higher authentication priority than username and password).
Activity
  • No specific activity (comments, reviews) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Python connector documentation to reflect newly added token-auth support for data subscription and introduces/clarifies related authentication configuration fields.

Changes:

  • Add version-history entries for taospy 2.8.9 and taos-ws-py 0.6.6 noting token-auth support for data subscription.
  • Update TMQ consumer configuration docs to distinguish cloud-token vs database-token authentication (including introducing td.connect.bearer_token in one section).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
docs/zh/14-reference/05-connector/30-python.mdx Adds new version-history rows and updates TMQ consumer auth property descriptions (token/bearer_token).
docs/en/14-reference/05-connector/30-python.md Adds new version-history rows and updates TMQ consumer auth property descriptions (token/bearer_token); includes a small connector-name typo near the updated version section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Python connector documentation to include recent changes, such as support for token authentication in data subscriptions. The changes look good overall, but I've pointed out a potential point of confusion in both the English and Chinese documents regarding the td.connect.token parameter, which appears to have different meanings for WebSocket and Native connections. Clarifying this would improve the documentation's usability.

@qevolg qevolg requested a review from a team as a code owner March 5, 2026 07:47
Copilot AI review requested due to automatic review settings March 5, 2026 07:54
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings March 10, 2026 07:55
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

docs/en/14-reference/05-connector/30-python.md:289

  • In the new __next__ return-value description, there appear to be stray/invisible characters between "values" and "of" (renders as "values of" or similar). Please replace with a normal single space to avoid odd rendering/searchability in the published docs.
  - **Parameter Description**:

docs/en/14-reference/05-connector/30-python.md:509

  • Same issue here: the return-value description contains stray/invisible characters between "values" and "of". Please replace them with a normal single space.
    - `precision`: Time precision

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants