-
Notifications
You must be signed in to change notification settings - Fork 9
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 doctests #207
Added doctests #207
Conversation
* Fixed an incorrect exception in `_Settings.__missing__` * Fixed a number of incorrect Sphinx domains * Clarified a few docstrings
|
||
import os | ||
|
||
collect_ignore = [os.path.join('src', 'qmflows', 'settings.py')] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ignore .../settings.py
, as it has issues failing the doctests due to inheriting a few faulty plams.Settings
-related docstring.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ignore
.../settings.py
, as it has issues failing the doctests due to inheriting a few faultyplams.Settings
-related docstring.
Thanks for let me know
Codecov Report
@@ Coverage Diff @@
## master #207 +/- ##
==========================================
+ Coverage 81.94% 82.64% +0.70%
==========================================
Files 39 39
Lines 1855 1855
Branches 235 235
==========================================
+ Hits 1520 1533 +13
+ Misses 265 251 -14
- Partials 70 71 +1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apart from the fact that I just don't understand the role of the ...
it is always great to test the examples in the documentation
|
||
import os | ||
|
||
collect_ignore = [os.path.join('src', 'qmflows', 'settings.py')] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ignore
.../settings.py
, as it has issues failing the doctests due to inheriting a few faultyplams.Settings
-related docstring.
Thanks for let me know
src/qmflows/backports.py
Outdated
@@ -30,11 +30,17 @@ class _NullContextBackup(AbstractContextManager): | |||
Used as a stand-in for a normal context manager, when a particular | |||
block of code is only sometimes used with a normal context manager: | |||
|
|||
.. testsetup:: python | |||
|
|||
>>> cm = ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is the meaning of thoese 3 dots there?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah good catch, that line of code is actually completely redundant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed in 054cb6e.
Implementation of #177.