Fix analytics event documentation formatting

[zachmargolis]

• "Email and Password Authentication" description was wrong
• Similar to Fix documentation formatting for Analytics Events #11640

Before

The description included some notes from the new_device attribute

> make analytics_events
> jq -r '.events[] | select( .event_name | contains("Email and Password") ) | .description' < public/api/_analytics-events.json
the attempt was unsuccessful, since it cannot be known whether it's a new device.
Tracks authentication attempts at the email/password screen

After

The description is only the description

> make analytics_events
> jq -r '.events[] | select( .event_name | contains("Email and Password") ) | .description' < public/api/_analytics-events.json
Tracks authentication attempts at the email/password screen

[aduth]

LGTM 👍

Another idea for enforcing this: Maybe we can require that the method description starts uppercase? That might be enough of a hint to people in scenarios like this.

[zachmargolis]

Another idea for enforcing this: Maybe we can require that the method description starts uppercase? That might be enough of a hint to people in scenarios like this.

Oh that's a great idea! Let me give that a shot

[zachmargolis]

Another idea for enforcing this: Maybe we can require that the method description starts uppercase? That might be enough of a hint to people in scenarios like this.

Oh that's a great idea! Let me give that a shot

Ok so after doing that, a few updates!

• Basic lowercase checking in ac7a2ec
• Turns out # rubocop:disable FooBar lines were getting included in descriptions and flagging this error, so in 3a6c537 I updated to strip those out, which is a win for the resulting documentation too
• Fixed errors in 46fa55c, which included capitalizing some desciptions

The errors now look like

app/services/analytics_events.rb:7109 sms_opt_in_visit method description starts with lowercase, check indentation

which hopefully is clear to future us what we are trying to fix

[aduth]

Big wins all around!

[aduth]

Could we include the parsed description in the error message so it'll be even more obvious if the description includes param text? For context, I was previously unaware of the indentation requirement, so "check indentation" probably wouldn't have been enough for me to realize if a description includes parameter text.

[zachmargolis]

How about 24e3453, which would look like this:

app/services/analytics_events.rb:249 add_email_confirmation method description starts with lowercase, check indentation:
  selection.
  A user has clicked the confirmation link in an email"

[aduth]

wfm 👍