Skip to content

docs: Update example of using GlobalTrajectoryMiddleware to specify what to logs#1412

Open
yuit wants to merge 1 commit intoi-am-bee:mainfrom
yuit:patch-3
Open

docs: Update example of using GlobalTrajectoryMiddleware to specify what to logs#1412
yuit wants to merge 1 commit intoi-am-bee:mainfrom
yuit:patch-3

Conversation

@yuit
Copy link

@yuit yuit commented Mar 19, 2026

Which issue(s) does this pull-request address?

Example is out-of-date. Examples incorrectly use target parameter to specify what to include in trajectory.

Description

Update the example to use included instead of target

Checklist

General

Code quality checks

  • Code quality checks pass: mise check (mise fix to auto-fix)

Testing

  • Unit tests pass: mise test:unit
  • E2E tests pass: mise test:e2e
  • Tests are included (for bug fixes or new features)

Documentation

  • Documentation is updated
  • Embedme embeds code examples in docs. To update after edits, run: Python mise docs:fix

… include

Signed-off-by: Yui <yuit@users.noreply.github.com>
@yuit yuit requested a review from a team as a code owner March 19, 2026 18:38
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 19, 2026
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 19, 2026
@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 addresses an out-of-date example in the documentation for GlobalTrajectoryMiddleware. The change ensures that the documentation accurately reflects the current API by replacing the target parameter with included for specifying logging configurations, thereby improving clarity and correctness for users.

Highlights

  • Documentation Update: The example for GlobalTrajectoryMiddleware in the documentation has been updated to use the correct parameter included instead of the outdated target when specifying what to log.

🧠 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.

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.

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 corrects an example in the documentation for GlobalTrajectoryMiddleware. The target parameter was being used to specify which classes to log, which was incorrect. This has been updated to use the included parameter, which is the correct way to filter logged classes. This change makes the documentation consistent with the implementation, which will help prevent user confusion.

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

Labels

documentation Improvements or additions to documentation size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant