Skip to content

Fix inline docs for InstallationEvent type #1808

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

Merged
merged 1 commit into from
Feb 21, 2021
Merged

Fix inline docs for InstallationEvent type #1808

merged 1 commit into from
Feb 21, 2021

Conversation

andygrunwald
Copy link
Contributor

What type of PR is this?

documentation

What this PR does / why we need it:

The inline documentation for the InstallationEvent went out of date.
This PR fixes the link + possible values.

Furthermore, does the REST API send a requester key as well.
In my current use-case, this was null, hence I am not aware of the type (is not documented).
As a trade-off for now, I added a TODO. Once the type is known, this can be extended

Special notes for your reviewer:

This applies the same fix as in #1780

Does this PR introduce a user-facing change?:

None

Additional documentation e.g., usage docs, etc.:

@google-cla google-cla bot added the cla: yes Indication that the PR author has signed a Google Contributor License Agreement. label Feb 21, 2021
@codecov
Copy link

codecov bot commented Feb 21, 2021

Codecov Report

Merging #1808 (5944538) into master (5c87615) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1808   +/-   ##
=======================================
  Coverage   97.59%   97.59%           
=======================================
  Files         100      100           
  Lines        6521     6521           
=======================================
  Hits         6364     6364           
  Misses         85       85           
  Partials       72       72           
Impacted Files Coverage Δ
github/event_types.go 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5c87615...031b738. Read the comment docs.

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

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

Thank you, @andygrunwald !
LGTM.
Merging.

@gmlewis gmlewis merged commit bff639e into google:master Feb 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indication that the PR author has signed a Google Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants