Skip to content

Update AnalyticsEventsDocumenter to require exact "**extra"#11860

Merged
aduth merged 1 commit intomainfrom
aduth-analytics-extra-exact
Feb 10, 2025
Merged

Update AnalyticsEventsDocumenter to require exact "**extra"#11860
aduth merged 1 commit intomainfrom
aduth-analytics-extra-exact

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Feb 7, 2025

🛠 Summary of changes

Updates make lint_analytics_events to check for consistent use of **extra extra keyword arguments on analytics events methods when required. Previously, the check was flexible in allowing other names, or unused variables (prefixed with _).

Why? So that we're consistent with how we expect additional keyword arguments to be logged.

📜 Testing Plan

Verify build passes.

Optional: Check for AnalyticsEvents method keyword arguments not named **extra.

changelog: Internal, Analytics, Update AnalyticsEventsDocumenter to require exact "**extra"
Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great catch!

@aduth aduth merged commit 41aff44 into main Feb 10, 2025
1 check passed
@aduth aduth deleted the aduth-analytics-extra-exact branch February 10, 2025 17:00
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