Skip to content

Improve README example formatting#19

Merged
sozercan merged 1 commit intomainfrom
docs/improve-readme-example-formatting
Apr 24, 2026
Merged

Improve README example formatting#19
sozercan merged 1 commit intomainfrom
docs/improve-readme-example-formatting

Conversation

@sozercan
Copy link
Copy Markdown
Owner

Summary

  • align inline comments in README command examples for easier scanning
  • clarify wording in the Configuration and API Explorer examples
  • wrap the long websearch example for readability while keeping commands unchanged

Testing

  • not run (documentation-only changes)

Copilot AI review requested due to automatic review settings April 23, 2026 23:49
Copy link
Copy Markdown

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 the readability of the README’s command examples by aligning inline comments, clarifying a few descriptions, and wrapping an overly long example while keeping the command semantics the same.

Changes:

  • Align inline # ... comments in Quick Start and other example blocks for easier scanning.
  • Clarify wording in the Configuration examples and the API Explorer examples.
  • Wrap the long a365 websearch ... example across two lines using bash line continuation for readability.
Show a summary per file
File Description
README.md Re-formats and clarifies README command examples (alignment, wording tweaks, and a wrapped long command).

Copilot's findings

Tip

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

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@sozercan sozercan merged commit 13a69f1 into main Apr 24, 2026
9 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.

2 participants