Skip to content

Conversation

@AustinBenoit
Copy link
Contributor

The documentation is referencing the C++ vector version and it should be removed.

Description

Provide details of the change, and generalize the change in the PR title above.

Ignoring the vector implementation of the SetDefaultEventParameters and the the LogEvent. This should prevent the autogenerate docs from including the random vector types that are not helpful for end SDK users.


Testing

Describe how you've tested these changes.


Type of Change

Place an x the applicable box:

  • Bug fix. Add the issue # below if applicable.
  • New feature. A non-breaking change which adds functionality.
  • Other, such as a build process or documentation change.

The documentation is referencing the C++ vector version and it should be removed
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @AustinBenoit, 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 aims to refine the auto-generated SDK documentation by explicitly excluding certain C++ std::vector overloads for LogEvent and SetDefaultEventParameters from the SWIG interface. The primary goal is to prevent the exposure of internal C++ types that are not relevant or helpful for end-users, thereby improving the clarity and usability of the SDK's public API documentation.

Highlights

  • Documentation Cleanup: The pull request introduces changes to ignore specific std::vector overloads of LogEvent and SetDefaultEventParameters within the SWIG interface.
  • SDK User Experience: This modification prevents the inclusion of internal C++ vector types in the auto-generated SDK documentation, ensuring a cleaner and more relevant API surface for end-users.
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 aims to prevent SWIG from generating C# wrappers for C++ functions that use std::vector<Parameter>, as these are not intended for direct SDK use. The changes correctly add %ignore directives for the vector-based overloads of LogEvent and SetDefaultEventParameters in the SWIG interface file. The changes look good, but I've suggested a small correction for a typo in a comment to improve clarity and maintain consistency within the file.

@AustinBenoit AustinBenoit merged commit faa96cc into main Dec 12, 2025
5 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