Skip to content
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

Added types and method docs to Rollbar and RollbarLogger classes #585

Merged
merged 2 commits into from
Dec 19, 2022

Conversation

danielmorell
Copy link
Collaborator

Description of the change

This PR adds typing and comments to the Rollbar and RollbarLogger classes. These two classes are the ones a developer is most likely to interact with the most. Because of that these are the two that need the changes typing and comments the most.

The PR also adds a few updates to the Config class, and fixes an incorrect return type.

The only code change that is not simply handling return types, argument types, or comments is in Rollbar::setLogger(). I had to read the method a few times to make sure I understood exactly what it was doing. I decided to simplify the logic, so it is easier to read and understand.

Lastly

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Maintenance
  • New release

Related issues

None

Checklists

Development

  • Lint rules pass locally
  • The code changed/added as part of this pull request has been covered with tests
  • All tests related to the changed code pass in development

Code review

  • This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
  • "Ready for review" label attached to the PR and reviewers assigned
  • Issue from task tracker has a link to this pull request
  • Changes have been reviewed by at least one other engineer

@danielmorell danielmorell added the Type: Maintenance General up-keep, or changes that tidy an existing component or process. label Dec 19, 2022
@danielmorell danielmorell added this to the v4.0.0 milestone Dec 19, 2022
Copy link
Contributor

@waltjones waltjones left a comment

Choose a reason for hiding this comment

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

Nice work on setLogger()!

@danielmorell danielmorell merged commit a54a15c into next/4.0/main Dec 19, 2022
@danielmorell danielmorell deleted the 4.0/added-types-comments branch December 19, 2022 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance General up-keep, or changes that tidy an existing component or process.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants