Dev/improve configurable documentation #406
Open
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
Purg
requested changes
Mar 6, 2020
Purg
requested changes
Mar 10, 2020
Purg
reviewed
May 5, 2020
There was a problem hiding this comment.
Not sure why travis-ci results are not showing readilly in the review section at the bottom, but that's still failing if you go to https://travis-ci.org/github/Kitware/SMQTK/ and then find your branch in there. TLDR there's a missing line-continuation in the doc-test.
It may be helpful to run pytest or setup.py test locally to make sure things pass and then use CI as a double check.
Comment on lines
+79
to
+80
| >>> NonCompliantDefault.get_default_config() == | ||
| ... {'power_func': {'module': 'math', 'attribute': 'pow'}} |
There was a problem hiding this comment.
Failing doc-test: requires a slash at the end for the line continuation.
Suggested change
| >>> NonCompliantDefault.get_default_config() == | |
| ... {'power_func': {'module': 'math', 'attribute': 'pow'}} | |
| >>> NonCompliantDefault.get_default_config() == \ | |
| ... {'power_func': {'module': 'math', 'attribute': 'pow'}} |
Comment on lines
+82
to
+83
| >>> json.dumps(NonCompliantDefault.get_default_config()) == | ||
| ... {"power_func": {"module": "math", "attribute": "pow"}} |
There was a problem hiding this comment.
Failing doc-test: requires a slash at the end for the line continuation.
Suggested change
| >>> json.dumps(NonCompliantDefault.get_default_config()) == | |
| ... {"power_func": {"module": "math", "attribute": "pow"}} | |
| >>> json.dumps(NonCompliantDefault.get_default_config()) == \ | |
| ... {"power_func": {"module": "math", "attribute": "pow"}} |
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.
No description provided.