Skip to content

Adding code comments to analytics.ts #535

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jul 23, 2019
Merged

Adding code comments to analytics.ts #535

merged 5 commits into from
Jul 23, 2019

Conversation

@esmacik
Copy link
Contributor

@esmacik esmacik commented Jul 22, 2019

  • Adding code comments to src/providers/analytics.ts, mostly from the existing analytics-externs.js file for event function, AnalyticsEventBuilder, AnalyticsEvent, and UserPropertyValue.
  • The rest of the documentation changes are just formatting tweaks so the generated docs will look nicer.
  • Adding hidden tags to the functions and a constant at the bottom of the file that need to be hidden.
  • Staged docs

@esmacik esmacik requested a review from egilmorez July 22, 2019 18:02
egilmorez
egilmorez reviewed Jul 22, 2019
View reviewed changes
egilmorez
egilmorez reviewed Jul 22, 2019
View reviewed changes
egilmorez
egilmorez reviewed Jul 22, 2019
View reviewed changes
egilmorez
egilmorez reviewed Jul 22, 2019
View reviewed changes
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

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

One nit and a terminology thing. Thanks esmacik!

thechenky
thechenky approved these changes Jul 22, 2019
View reviewed changes
Copy link
Contributor

@thechenky thechenky left a comment

Choose a reason for hiding this comment

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

Looks good!

src/providers/analytics.ts
/**
* Interface representing a Firebase Analytics event that was logged for a specific user.
*/
/** Interface representing a Firebase Analytics event that was logged for a specific user. */
Copy link
Contributor

@thechenky thechenky Jul 22, 2019

Choose a reason for hiding this comment

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

Does this fit on one line? Can't tell

@esmacik esmacik merged commit 6e97877 into master Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@egilmorez egilmorez egilmorez left review comments

@kevinajian kevinajian Awaiting requested review from kevinajian

+1 more reviewer

@thechenky thechenky thechenky approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@esmacik @egilmorez @thechenky