Update analytics events documentation to pull event name from source#6294
Merged
zachmargolis merged 2 commits intomainfrom May 3, 2022
Merged
Update analytics events documentation to pull event name from source#6294zachmargolis merged 2 commits intomainfrom
zachmargolis merged 2 commits intomainfrom
Conversation
**Why**: Currently we have to write each event name in two places, which leaves room for errors. changelog: Internal, Documentation, Update parsing for analytics events
aduth
approved these changes
May 3, 2022
Contributor
aduth
left a comment
aduth
left a comment
There was a problem hiding this comment.
I also worried about this problem. I think this is much nicer 👍
peggles2
pushed a commit
that referenced
this pull request
May 3, 2022
…6294) * Update analytics events documentation to pull event name from source **Why**: Currently we have to write each event name in two places, which leaves room for errors. changelog: Internal, Documentation, Update parsing for analytics events
zachmargolis
added a commit
that referenced
this pull request
May 4, 2022
- As of #6294, having it will cause build breakage since it's an unknown tag
zachmargolis
added a commit
that referenced
this pull request
May 4, 2022
* Remove @identity.idp.event_name - As of #6294, having it will cause build breakage since it's an unknown tag * Remove blank lines * Add clearer comments for each event
gsa-manish
added a commit
that referenced
this pull request
May 5, 2022
* LG-5929-document-analytics-11 * Patch: analytics events 11 (#6303) * Remove @identity.idp.event_name - As of #6294, having it will cause build breakage since it's an unknown tag * Remove blank lines * Add clearer comments for each event Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>
peggles2
pushed a commit
that referenced
this pull request
May 5, 2022
…6294) * Update analytics events documentation to pull event name from source **Why**: Currently we have to write each event name in two places, which leaves room for errors. changelog: Internal, Documentation, Update parsing for analytics events
peggles2
pushed a commit
that referenced
this pull request
May 5, 2022
* LG-5929-document-analytics-11 * Patch: analytics events 11 (#6303) * Remove @identity.idp.event_name - As of #6294, having it will cause build breakage since it's an unknown tag * Remove blank lines * Add clearer comments for each event Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why: Currently we have to write each event name in two places, which leaves room for errors.
changelog: Internal, Documentation, Update parsing for analytics events
I spotted an error in https://github.com/18F/identity-idp/pull/6293/files#r864009185, and then realized we had another error in source code already too 🙈 :
identity-idp/app/services/analytics_events.rb
Lines 145 to 149 in 0b8a222
I learned a bit more about the YARD objects in #6289, such as that we have access to the string source of the method, which lets us do cool stuff plike this