Skip to content
This repository has been archived by the owner. It is now read-only.

Fix constructor signature #210

Merged
merged 3 commits into from Jan 29, 2019
Merged

Fix constructor signature #210

merged 3 commits into from Jan 29, 2019

Conversation

@c-w
Copy link
Contributor

@c-w c-w commented Jan 29, 2019

All the subclasses take a configuration dictionary as constructor argument, so the interface definition should also mention it. In addition to improving documentation, this change will also make it safer to use reflection to look up and instantiate specific implementations of the interface since the constructor signature now is part of the official interface.

All Submissions:

  • Have you followed the guidelines in our Contributing document?

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

  • Does your PR follow our Code of Conduct?

  • Have you added an explanation of what your changes do and why you'd like us to include them?

  • Does each method or function "do one thing well"? Reviewers may recommend methods be split up for maintainability and testability.

  • Is this code designed to be testable? Not applicable: documentation change

  • Is the code documented well?

  • Does your submission pass existing tests (or update existing tests with documentation regarding the change)? Passes Docker build

  • Have you added tests to cover your changes? Not applicable: documentation change

  • Have you linted your code prior to submission? Passes Docker build

  • Have you updated the documentation and README?

  • Is PII treated correctly? In particular, make sure the code is not logging objects or strings that might contain PII (e.g. request headers). Not applicable: documentation change

  • Have secrets been stripped before committing? Not applicable: documentation change

c-w added 2 commits Jan 29, 2019
All the subclasses take a configuration dictionary as constructor
argument, so the interface definition should also mention it. In
addition to improving documentation, this change will also make it safer
to use reflection to look up and instantiate specific implementations of
the interface since the constructor signature now is part of the
official interface.
Copy link
Contributor

@margaretmeehan margaretmeehan left a comment

Nice improvements. We should be more explicit about what env vars are required where throughout the code.

sayar
sayar approved these changes Jan 29, 2019
@sayar sayar merged commit 04f815f into master Jan 29, 2019
1 of 2 checks passed
@sayar sayar deleted the fix-constructor-signature branch Jan 29, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants