-
Notifications
You must be signed in to change notification settings - Fork 218
fix: rename v1 Event to LegacyEvent to avoid api-extractor conflict #1767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @taeold, 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 primarily addresses a documentation generation issue by renaming the Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 addresses a naming conflict with api-extractor by renaming the v1 Event interface to LegacyEvent. This is a breaking change, as noted in the description. The renaming has been applied consistently across all relevant files. The change is straightforward and well-executed. I've added one minor suggestion to improve code clarity by removing a redundant type union.
c6b9463 to
e162cec
Compare
egilmorez
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"LegacyName" SGTM, thanks!
Unsure exactly what caused the change, but
Eventtype insrc/v1/cloud-functions.tsis not generating reference doc with odd suffixEvent_v2.This seems to be a known issue per microsoft/rushstack#3581.
I'm making a breaking change to rename the type to
LegacyEventinstead. This type is public, but I don't inspect wide usage since it represent internal state of the function triggers.