README: clarify code examples #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To use the functionality from the library, users can choose one of two methods to use it.
The existing code example in the readme was confusing as it used both methods in the same example, while at any time, only one method should be used.
This splits out the example into the two distinct usages.
Includes:
* Update namespace in code samples to make it clear that the user namespace is expected.
* Update test class name in code samples to make it clear this is an example.
* Remove `strict_types` declaration.
While this may just be my opinion, `strict_types` should not be used in test files as it can block the testing of unhappy paths.
rdohms
approved these changes
Apr 8, 2021
rdohms
added
the
Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
To use the functionality from the library, users can choose one of two methods to use it.
The existing code example in the readme was confusing as it used both methods in the same example, while at any time, only one method should be used.
This splits out the example into the two distinct usages.
Includes:
strict_typesdeclaration.While this may just be my opinion,
strict_typesshould not be used in test files as it can block the testing of unhappy paths.