Added types and method docs to Rollbar
and RollbarLogger
classes
#585
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.
Description of the change
This PR adds typing and comments to the
Rollbar
andRollbarLogger
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
Related issues
None
Checklists
Development
Code review