Skip to content

Conversation

@zhaodongwang-msft
Copy link
Collaborator

This pull request updates documentation and example code references to improve clarity and usability. The most important changes include updating all example links in the README.md to use absolute GitHub URLs, and clarifying a log message in the advanced walkthrough example.

Documentation improvements:

  • Updated all example links in README.md from relative paths to absolute GitHub URLs for easier navigation and sharing.
  • Changed the reference to the examples README in README.md to use an absolute GitHub URL.

Example code clarity:

  • Revised a log message in examples/advanced/walkthrough.py to clarify that the create_table method uses a columns argument instead of a generic schema.

@zhaodongwang-msft zhaodongwang-msft requested a review from a team as a code owner November 18, 2025 00:31
Copilot AI review requested due to automatic review settings November 18, 2025 00:31
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

This PR improves documentation accessibility and corrects example code to match the public API. The changes ensure the README renders correctly on PyPI with working links and that example code accurately reflects the public API parameter names.

  • Updated all example links in README.md to absolute GitHub URLs for PyPI compatibility
  • Corrected a log message in the walkthrough example to use the correct public API parameter name (columns instead of schema)

Reviewed Changes

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

File Description
README.md Converted relative links to absolute GitHub URLs for better PyPI display and accessibility
examples/advanced/walkthrough.py Updated log message to correctly reference the columns parameter instead of schema to match the public API

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

@zhaodongwang-msft zhaodongwang-msft merged commit ef0a4d3 into main Nov 18, 2025
14 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