Skip to content

Clarifications in docs#392

Merged
ppinchuk merged 3 commits intomainfrom
pp/fix_docs
Mar 11, 2026
Merged

Clarifications in docs#392
ppinchuk merged 3 commits intomainfrom
pp/fix_docs

Conversation

@ppinchuk
Copy link
Copy Markdown
Collaborator

Clarify model name in documentation and examples, and update outdated config keys. Thanks @castelao for pointing all of these out!

@ppinchuk ppinchuk self-assigned this Mar 11, 2026
@ppinchuk ppinchuk requested a review from castelao as a code owner March 11, 2026 21:57
Copilot AI review requested due to automatic review settings March 11, 2026 21:58
@ppinchuk ppinchuk added documentation Improvements or additions to documentation bugfix Fixed a known bug p-high Priority: high labels Mar 11, 2026
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 54.49%. Comparing base (fc01226) to head (b50bafd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #392   +/-   ##
=======================================
  Coverage   54.49%   54.49%           
=======================================
  Files          61       61           
  Lines        5652     5652           
  Branches      530      530           
=======================================
  Hits         3080     3080           
  Misses       2526     2526           
  Partials       46       46           
Flag Coverage Δ
unittests 54.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
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 updates the execution-basics examples and documentation to better reflect Azure OpenAI deployment naming and to replace outdated Azure client config keys with the ones expected by the current OpenAI/Azure client initialization.

Changes:

  • Update example JSON5 configs to use client_kwargs.api_key / client_kwargs.api_version (instead of azure_api_key / azure_version) and clarify Azure deployment naming.
  • Add an IMPORTANT note to the execution-basics README about Azure deployment model naming.
  • Add a similar IMPORTANT note to the process_jurisdictions_with_openai docstring.

Reviewed changes

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

File Description
examples/execution_basics/config_recommended.json5 Updates example Azure client config keys and clarifies deployment naming.
examples/execution_basics/config_kitchen_sink.json5 Same key updates across multiple model entries; adds clarifying comments for Azure vs OpenAI naming.
examples/execution_basics/README.rst Adds an IMPORTANT note about Azure deployment model naming in configs.
compass/scripts/process.py Adds an IMPORTANT note to the public docstring about Azure deployment model naming.

You can also share your feedback on Copilot code review. Take the survey.

@ppinchuk ppinchuk merged commit 7e17785 into main Mar 11, 2026
22 checks passed
@ppinchuk ppinchuk deleted the pp/fix_docs branch March 11, 2026 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix Fixed a known bug documentation Improvements or additions to documentation p-high Priority: high

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants