Skip to content

docs: update python docs#34737

Merged
zitsen merged 1 commit intomainfrom
docs/main/6877686960
Mar 10, 2026
Merged

docs: update python docs#34737
zitsen merged 1 commit intomainfrom
docs/main/6877686960

Conversation

@qevolg
Copy link
Contributor

@qevolg qevolg commented Mar 10, 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 10, 2026 07:59
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 reference docs to better reflect TaosResult behavior and APIs, aligning the field-count description and documenting iterator support.

Changes:

  • Correct field_count documentation to indicate it returns the number of fields (not the number of records).
  • Document iterator protocol support for TaosResult via __iter__ / __next__ in both Rust-binding and native Python API sections.

Reviewed changes

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

File Description
docs/zh/14-reference/05-connector/30-python.mdx Fixes field_count meaning and adds TaosResult iterator method docs (ZH).
docs/en/14-reference/05-connector/30-python.md Same doc updates in English; minor text formatting issue noted in __next__ return description.

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

@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 focuses on enhancing the Python connector documentation. It clarifies the description of an existing method and introduces comprehensive documentation for the iterator protocol, enabling users to better understand and utilize the TaosResult object for data retrieval.

Highlights

  • Documentation Update: Updated the description of the field_count method for the TaosResult object in the Python connector documentation to accurately reflect its purpose.
  • Iterator Protocol Documentation: Added comprehensive documentation for the __iter__ and __next__ methods, explaining how to enable and use the iterator protocol for TaosResult objects to traverse query results.

🧠 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
    • Clarified the description of the field_count method.
    • Documented the __iter__ method for TaosResult objects.
    • Documented the __next__ method for TaosResult objects.
  • docs/zh/14-reference/05-connector/30-python.mdx
    • Clarified the description of the field_count method.
    • Documented the __iter__ method for TaosResult objects.
    • Documented the __next__ method for TaosResult objects.
Activity
  • The author marked the "Is the user manual updated?" checklist item as complete.
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

@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, correcting the description for field_count and adding documentation for the __iter__ and __next__ methods. These changes improve the accuracy and completeness of the documentation. I've identified a couple of minor typos in the English documentation and provided suggestions to fix them.

@zitsen zitsen merged commit da5ac3b into main Mar 10, 2026
11 checks passed
@zitsen zitsen deleted the docs/main/6877686960 branch March 10, 2026 11:58
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.

4 participants